From 3634f3ad50569d342a3fcf1a5fd0f2177d27c135 Mon Sep 17 00:00:00 2001 From: Andrew Richardson Date: Wed, 30 Apr 2025 22:19:34 -0400 Subject: [PATCH 1/7] Update openapi-typescript to latest Signed-off-by: Andrew Richardson --- package-lock.json | 730 ++++++++++++++++++++++++++++++++++----------- package.json | 8 +- scripts/schema.mjs | 19 -- scripts/schema.ts | 14 + 4 files changed, 581 insertions(+), 190 deletions(-) delete mode 100644 scripts/schema.mjs create mode 100644 scripts/schema.ts diff --git a/package-lock.json b/package-lock.json index 55c9dfe..d2d27b6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,30 +22,47 @@ "eslint": "^8.12.0", "eslint-plugin-import": "^2.25.4", "mocha": "^10.0.0", - "openapi-typescript": "^5.4.1", + "openapi-typescript": "^7.6.1", "prettier": "^2.6.1", "rimraf": "^3.0.2", "sinon": "^14.0.0", - "ts-node": "^10.7.0", - "typescript": "^4.6.3" + "ts-node": "^10.9.2", + "typescript": "^5.8.3" } }, - "node_modules/@cspotcode/source-map-consumer": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/@cspotcode/source-map-consumer/-/source-map-consumer-0.8.0.tgz", - "integrity": "sha512-41qniHzTU8yAGbCp04ohlmSrZf8bkf/iJsl3V0dRGsQN/5GFfx+LbCSsCpp2gqrqjTVg/K6O8ycoV35JIwAzAg==", + "node_modules/@babel/code-frame": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.27.1.tgz", + "integrity": "sha512-cjQ7ZlQ0Mv3b47hABuTevyTuYN4i+loJKGeV9flcCgIK37cCXRh+L1bd3iBHlynerhQ7BhCkn2BPbQUL+rGqFg==", "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.27.1", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, "engines": { - "node": ">= 12" + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.27.1.tgz", + "integrity": "sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" } }, "node_modules/@cspotcode/source-map-support": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.7.0.tgz", - "integrity": "sha512-X4xqRHqN8ACt2aHVe51OxeA2HjbcL4MqFqXkrmQszJ1NOUuUu5u6Vqx/0lZSVNku7velL5FC/s5uEAj1lsBMhA==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", "dev": true, + "license": "MIT", "dependencies": { - "@cspotcode/source-map-consumer": "0.8.0" + "@jridgewell/trace-mapping": "0.3.9" }, "engines": { "node": ">=12" @@ -71,15 +88,6 @@ "node": "^12.22.0 || ^14.17.0 || >=16.0.0" } }, - "node_modules/@fastify/busboy": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", - "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==", - "dev": true, - "engines": { - "node": ">=14" - } - }, "node_modules/@humanwhocodes/config-array": { "version": "0.9.5", "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.9.5.tgz", @@ -100,6 +108,34 @@ "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==", "dev": true }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", + "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -135,6 +171,82 @@ "node": ">= 8" } }, + "node_modules/@redocly/ajv": { + "version": "8.11.2", + "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.2.tgz", + "integrity": "sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js-replace": "^1.0.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@redocly/ajv/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true, + "license": "MIT" + }, + "node_modules/@redocly/config": { + "version": "0.22.2", + "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.22.2.tgz", + "integrity": "sha512-roRDai8/zr2S9YfmzUfNhKjOF0NdcOIqF7bhf4MVC5UxpjIysDjyudvlAiVbpPHp3eDRWbdzUgtkK1a7YiDNyQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@redocly/openapi-core": { + "version": "1.34.2", + "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.34.2.tgz", + "integrity": "sha512-glfkQFJizLdq2fBkNvc2FJW0sxDb5exd0wIXhFk+WHaFLMREBC3CxRo2Zq7uJIdfV9U3YTceMbXJklpDfmmwFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@redocly/ajv": "^8.11.2", + "@redocly/config": "^0.22.0", + "colorette": "^1.2.0", + "https-proxy-agent": "^7.0.5", + "js-levenshtein": "^1.1.6", + "js-yaml": "^4.1.0", + "minimatch": "^5.0.1", + "pluralize": "^8.0.0", + "yaml-ast-parser": "0.0.43" + }, + "engines": { + "node": ">=18.17.0", + "npm": ">=9.5.0" + } + }, + "node_modules/@redocly/openapi-core/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/@redocly/openapi-core/node_modules/minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", @@ -558,6 +670,16 @@ "node": ">=0.4.0" } }, + "node_modules/agent-base": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz", + "integrity": "sha512-jRR5wdylq8CkOe6hei19GGZnxM6rBGwFl3Bg0YItGDimvjGtAvdZk4Pu6Cl4u4Igsws4a1fd1Vq3ezrhn4KmFw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14" + } + }, "node_modules/ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", @@ -785,6 +907,13 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, + "node_modules/change-case": { + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz", + "integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==", + "dev": true, + "license": "MIT" + }, "node_modules/chokidar": { "version": "3.5.3", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz", @@ -853,6 +982,13 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, + "node_modules/colorette": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz", + "integrity": "sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g==", + "dev": true, + "license": "MIT" + }, "node_modules/combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -1577,12 +1713,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/globalyzer": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/globalyzer/-/globalyzer-0.1.0.tgz", - "integrity": "sha512-40oNTM9UfG6aBmuKxk/giHn5nQ8RVz/SS4Ir6zgzOv9/qC3kKZ9v4etGTcJbEl/NyVQH7FGU7d+X1egr57Md2Q==", - "dev": true - }, "node_modules/globby": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", @@ -1603,12 +1733,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/globrex": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/globrex/-/globrex-0.1.2.tgz", - "integrity": "sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==", - "dev": true - }, "node_modules/has": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", @@ -1675,6 +1799,20 @@ "he": "bin/he" } }, + "node_modules/https-proxy-agent": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", + "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", + "dev": true, + "license": "MIT", + "dependencies": { + "agent-base": "^7.1.2", + "debug": "4" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/ignore": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", @@ -1709,6 +1847,19 @@ "node": ">=0.8.19" } }, + "node_modules/index-to-position": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/index-to-position/-/index-to-position-1.1.0.tgz", + "integrity": "sha512-XPdx9Dq4t9Qk1mTMbWONJqU7boCoumEH7fRET37HX5+khDUl3J2W6PdALxhILYlIYx2amlwYcRPp28p0tSiojg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -1984,6 +2135,23 @@ "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", "dev": true }, + "node_modules/js-levenshtein": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/js-levenshtein/-/js-levenshtein-1.1.6.tgz", + "integrity": "sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, "node_modules/js-yaml": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", @@ -2120,18 +2288,6 @@ "node": ">=8.6" } }, - "node_modules/mime": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/mime/-/mime-3.0.0.tgz", - "integrity": "sha512-jSCU7/VB1loIWBZe14aEYHU/+1UMEHoaO7qxCOVJOw9GgH72VAWppxNcjU+x9a2k3GSIBXNKxXQFqRvvZ7vr3A==", - "dev": true, - "bin": { - "mime": "cli.js" - }, - "engines": { - "node": ">=10.0.0" - } - }, "node_modules/mime-db": { "version": "1.52.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", @@ -2449,23 +2605,47 @@ } }, "node_modules/openapi-typescript": { - "version": "5.4.1", - "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-5.4.1.tgz", - "integrity": "sha512-AGB2QiZPz4rE7zIwV3dRHtoUC/CWHhUjuzGXvtmMQN2AFV8xCTLKcZUHLcdPQmt/83i22nRE7+TxXOXkK+gf4Q==", + "version": "7.6.1", + "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.6.1.tgz", + "integrity": "sha512-F7RXEeo/heF3O9lOXo2bNjCOtfp7u+D6W3a3VNEH2xE6v+fxLtn5nq0uvUcA1F5aT+CMhNeC5Uqtg5tlXFX/ag==", "dev": true, + "license": "MIT", "dependencies": { - "js-yaml": "^4.1.0", - "mime": "^3.0.0", - "prettier": "^2.6.2", - "tiny-glob": "^0.2.9", - "undici": "^5.4.0", - "yargs-parser": "^21.0.1" + "@redocly/openapi-core": "^1.28.0", + "ansi-colors": "^4.1.3", + "change-case": "^5.4.4", + "parse-json": "^8.1.0", + "supports-color": "^9.4.0", + "yargs-parser": "^21.1.1" }, "bin": { "openapi-typescript": "bin/cli.js" }, + "peerDependencies": { + "typescript": "^5.x" + } + }, + "node_modules/openapi-typescript/node_modules/ansi-colors": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", + "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", + "dev": true, + "license": "MIT", "engines": { - "node": ">= 14.0.0" + "node": ">=6" + } + }, + "node_modules/openapi-typescript/node_modules/supports-color": { + "version": "9.4.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-9.4.0.tgz", + "integrity": "sha512-VL+lNrEoIXww1coLPOmiEmK/0sGigko5COxI09KzHc2VJXJsQ37UaQ+8quuxjDeA7+KnLGTWRyOXSLLR2Wb4jw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" } }, "node_modules/optionator": { @@ -2530,6 +2710,37 @@ "node": ">=6" } }, + "node_modules/parse-json": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-8.3.0.tgz", + "integrity": "sha512-ybiGyvspI+fAoRQbIPRddCcSTV9/LsJbf0e/S85VLowVGzRmokfneg2kwVW/KU5rOXrPSbF1qAKPMgNTqqROQQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.26.2", + "index-to-position": "^1.1.0", + "type-fest": "^4.39.1" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parse-json/node_modules/type-fest": { + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.40.1.tgz", + "integrity": "sha512-9YvLNnORDpI+vghLU/Nf+zSv0kL47KbVJ1o3sKgoTefl6i+zebxbiDQWoe/oWWqPhIgQdRZRT1KA9sCPL810SA==", + "dev": true, + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/path-exists": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", @@ -2581,6 +2792,13 @@ "node": ">=8" } }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, "node_modules/picomatch": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", @@ -2593,6 +2811,16 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, + "node_modules/pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, "node_modules/prelude-ls": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", @@ -2693,6 +2921,16 @@ "node": ">=0.10.0" } }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/resolve": { "version": "1.22.0", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.0.tgz", @@ -2985,16 +3223,6 @@ "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", "dev": true }, - "node_modules/tiny-glob": { - "version": "0.2.9", - "resolved": "https://registry.npmjs.org/tiny-glob/-/tiny-glob-0.2.9.tgz", - "integrity": "sha512-g/55ssRPUjShh+xkfx9UPDXqhckHEsHr4Vd9zX55oSdGZc/MD0m3sferOkwWtp98bv+kcVfEHtRJgBVJzelrzg==", - "dev": true, - "dependencies": { - "globalyzer": "0.1.0", - "globrex": "^0.1.2" - } - }, "node_modules/to-regex-range": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", @@ -3008,12 +3236,13 @@ } }, "node_modules/ts-node": { - "version": "10.7.0", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.7.0.tgz", - "integrity": "sha512-TbIGS4xgJoX2i3do417KSaep1uRAW/Lu+WAL2doDHC0D6ummjirVOXU5/7aiZotbQ5p1Zp9tP7U6cYhA0O7M8A==", + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", "dev": true, + "license": "MIT", "dependencies": { - "@cspotcode/source-map-support": "0.7.0", + "@cspotcode/source-map-support": "^0.8.0", "@tsconfig/node10": "^1.0.7", "@tsconfig/node12": "^1.0.7", "@tsconfig/node14": "^1.0.0", @@ -3024,7 +3253,7 @@ "create-require": "^1.1.0", "diff": "^4.0.1", "make-error": "^1.1.1", - "v8-compile-cache-lib": "^3.0.0", + "v8-compile-cache-lib": "^3.0.1", "yn": "3.1.1" }, "bin": { @@ -3117,16 +3346,17 @@ } }, "node_modules/typescript": { - "version": "4.6.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.6.3.tgz", - "integrity": "sha512-yNIatDa5iaofVozS/uQJEl3JRWLKKGJKh6Yaiv0GLGSuhpFJe7P3SbHZ8/yjAHRQwKRoA6YZqlfjXWmVzoVSMw==", + "version": "5.8.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", + "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", "dev": true, + "license": "Apache-2.0", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=4.2.0" + "node": ">=14.17" } }, "node_modules/unbox-primitive": { @@ -3144,18 +3374,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", - "dev": true, - "dependencies": { - "@fastify/busboy": "^2.0.0" - }, - "engines": { - "node": ">=14.0" - } - }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -3165,6 +3383,13 @@ "punycode": "^2.1.0" } }, + "node_modules/uri-js-replace": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/uri-js-replace/-/uri-js-replace-1.0.1.tgz", + "integrity": "sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g==", + "dev": true, + "license": "MIT" + }, "node_modules/v8-compile-cache": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", @@ -3172,10 +3397,11 @@ "dev": true }, "node_modules/v8-compile-cache-lib": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.0.tgz", - "integrity": "sha512-mpSYqfsFvASnSn5qMiwrr4VKfumbPyONLCOPmsR3A6pTY/r0+tSaVbgPWSAIuzbk3lCTa+FForeTiO+wBQGkjA==", - "dev": true + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", + "dev": true, + "license": "MIT" }, "node_modules/which": { "version": "2.0.2", @@ -3281,6 +3507,13 @@ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "dev": true }, + "node_modules/yaml-ast-parser": { + "version": "0.0.43", + "resolved": "https://registry.npmjs.org/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz", + "integrity": "sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A==", + "dev": true, + "license": "Apache-2.0" + }, "node_modules/yargs": { "version": "16.2.0", "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", @@ -3300,10 +3533,11 @@ } }, "node_modules/yargs-parser": { - "version": "21.0.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.0.1.tgz", - "integrity": "sha512-9BK1jFpLzJROCI5TzwZL/TU4gqjK5xiHV/RfWLOahrjAko/e4DJkRDZQXfvqAsiZzzYhgAzbgz6lg48jcm4GLg==", + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", "dev": true, + "license": "ISC", "engines": { "node": ">=12" } @@ -3355,19 +3589,30 @@ } }, "dependencies": { - "@cspotcode/source-map-consumer": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/@cspotcode/source-map-consumer/-/source-map-consumer-0.8.0.tgz", - "integrity": "sha512-41qniHzTU8yAGbCp04ohlmSrZf8bkf/iJsl3V0dRGsQN/5GFfx+LbCSsCpp2gqrqjTVg/K6O8ycoV35JIwAzAg==", + "@babel/code-frame": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.27.1.tgz", + "integrity": "sha512-cjQ7ZlQ0Mv3b47hABuTevyTuYN4i+loJKGeV9flcCgIK37cCXRh+L1bd3iBHlynerhQ7BhCkn2BPbQUL+rGqFg==", + "dev": true, + "requires": { + "@babel/helper-validator-identifier": "^7.27.1", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + } + }, + "@babel/helper-validator-identifier": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.27.1.tgz", + "integrity": "sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow==", "dev": true }, "@cspotcode/source-map-support": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.7.0.tgz", - "integrity": "sha512-X4xqRHqN8ACt2aHVe51OxeA2HjbcL4MqFqXkrmQszJ1NOUuUu5u6Vqx/0lZSVNku7velL5FC/s5uEAj1lsBMhA==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", "dev": true, "requires": { - "@cspotcode/source-map-consumer": "0.8.0" + "@jridgewell/trace-mapping": "0.3.9" } }, "@eslint/eslintrc": { @@ -3387,12 +3632,6 @@ "strip-json-comments": "^3.1.1" } }, - "@fastify/busboy": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", - "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==", - "dev": true - }, "@humanwhocodes/config-array": { "version": "0.9.5", "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.9.5.tgz", @@ -3410,6 +3649,28 @@ "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==", "dev": true }, + "@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true + }, + "@jridgewell/sourcemap-codec": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", + "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", + "dev": true + }, + "@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "requires": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, "@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -3436,6 +3697,69 @@ "fastq": "^1.6.0" } }, + "@redocly/ajv": { + "version": "8.11.2", + "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.2.tgz", + "integrity": "sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js-replace": "^1.0.1" + }, + "dependencies": { + "json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true + } + } + }, + "@redocly/config": { + "version": "0.22.2", + "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.22.2.tgz", + "integrity": "sha512-roRDai8/zr2S9YfmzUfNhKjOF0NdcOIqF7bhf4MVC5UxpjIysDjyudvlAiVbpPHp3eDRWbdzUgtkK1a7YiDNyQ==", + "dev": true + }, + "@redocly/openapi-core": { + "version": "1.34.2", + "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.34.2.tgz", + "integrity": "sha512-glfkQFJizLdq2fBkNvc2FJW0sxDb5exd0wIXhFk+WHaFLMREBC3CxRo2Zq7uJIdfV9U3YTceMbXJklpDfmmwFQ==", + "dev": true, + "requires": { + "@redocly/ajv": "^8.11.2", + "@redocly/config": "^0.22.0", + "colorette": "^1.2.0", + "https-proxy-agent": "^7.0.5", + "js-levenshtein": "^1.1.6", + "js-yaml": "^4.1.0", + "minimatch": "^5.0.1", + "pluralize": "^8.0.0", + "yaml-ast-parser": "0.0.43" + }, + "dependencies": { + "brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0" + } + }, + "minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "requires": { + "brace-expansion": "^2.0.1" + } + } + } + }, "@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", @@ -3724,6 +4048,12 @@ "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", "dev": true }, + "agent-base": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz", + "integrity": "sha512-jRR5wdylq8CkOe6hei19GGZnxM6rBGwFl3Bg0YItGDimvjGtAvdZk4Pu6Cl4u4Igsws4a1fd1Vq3ezrhn4KmFw==", + "dev": true + }, "ajv": { "version": "6.12.6", "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", @@ -3893,6 +4223,12 @@ "supports-color": "^7.1.0" } }, + "change-case": { + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz", + "integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==", + "dev": true + }, "chokidar": { "version": "3.5.3", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz", @@ -3946,6 +4282,12 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, + "colorette": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz", + "integrity": "sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g==", + "dev": true + }, "combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -4498,12 +4840,6 @@ "type-fest": "^0.20.2" } }, - "globalyzer": { - "version": "0.1.0", - "resolved": "https://registry.npmjs.org/globalyzer/-/globalyzer-0.1.0.tgz", - "integrity": "sha512-40oNTM9UfG6aBmuKxk/giHn5nQ8RVz/SS4Ir6zgzOv9/qC3kKZ9v4etGTcJbEl/NyVQH7FGU7d+X1egr57Md2Q==", - "dev": true - }, "globby": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", @@ -4518,12 +4854,6 @@ "slash": "^3.0.0" } }, - "globrex": { - "version": "0.1.2", - "resolved": "https://registry.npmjs.org/globrex/-/globrex-0.1.2.tgz", - "integrity": "sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==", - "dev": true - }, "has": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", @@ -4566,6 +4896,16 @@ "integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==", "dev": true }, + "https-proxy-agent": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", + "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", + "dev": true, + "requires": { + "agent-base": "^7.1.2", + "debug": "4" + } + }, "ignore": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", @@ -4588,6 +4928,12 @@ "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", "dev": true }, + "index-to-position": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/index-to-position/-/index-to-position-1.1.0.tgz", + "integrity": "sha512-XPdx9Dq4t9Qk1mTMbWONJqU7boCoumEH7fRET37HX5+khDUl3J2W6PdALxhILYlIYx2amlwYcRPp28p0tSiojg==", + "dev": true + }, "inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -4776,6 +5122,18 @@ "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", "dev": true }, + "js-levenshtein": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/js-levenshtein/-/js-levenshtein-1.1.6.tgz", + "integrity": "sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g==", + "dev": true + }, + "js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, "js-yaml": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", @@ -4885,12 +5243,6 @@ "picomatch": "^2.3.1" } }, - "mime": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/mime/-/mime-3.0.0.tgz", - "integrity": "sha512-jSCU7/VB1loIWBZe14aEYHU/+1UMEHoaO7qxCOVJOw9GgH72VAWppxNcjU+x9a2k3GSIBXNKxXQFqRvvZ7vr3A==", - "dev": true - }, "mime-db": { "version": "1.52.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", @@ -5121,17 +5473,31 @@ } }, "openapi-typescript": { - "version": "5.4.1", - "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-5.4.1.tgz", - "integrity": "sha512-AGB2QiZPz4rE7zIwV3dRHtoUC/CWHhUjuzGXvtmMQN2AFV8xCTLKcZUHLcdPQmt/83i22nRE7+TxXOXkK+gf4Q==", + "version": "7.6.1", + "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.6.1.tgz", + "integrity": "sha512-F7RXEeo/heF3O9lOXo2bNjCOtfp7u+D6W3a3VNEH2xE6v+fxLtn5nq0uvUcA1F5aT+CMhNeC5Uqtg5tlXFX/ag==", "dev": true, "requires": { - "js-yaml": "^4.1.0", - "mime": "^3.0.0", - "prettier": "^2.6.2", - "tiny-glob": "^0.2.9", - "undici": "^5.4.0", - "yargs-parser": "^21.0.1" + "@redocly/openapi-core": "^1.28.0", + "ansi-colors": "^4.1.3", + "change-case": "^5.4.4", + "parse-json": "^8.1.0", + "supports-color": "^9.4.0", + "yargs-parser": "^21.1.1" + }, + "dependencies": { + "ansi-colors": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", + "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", + "dev": true + }, + "supports-color": { + "version": "9.4.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-9.4.0.tgz", + "integrity": "sha512-VL+lNrEoIXww1coLPOmiEmK/0sGigko5COxI09KzHc2VJXJsQ37UaQ+8quuxjDeA7+KnLGTWRyOXSLLR2Wb4jw==", + "dev": true + } } }, "optionator": { @@ -5181,6 +5547,25 @@ "callsites": "^3.0.0" } }, + "parse-json": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-8.3.0.tgz", + "integrity": "sha512-ybiGyvspI+fAoRQbIPRddCcSTV9/LsJbf0e/S85VLowVGzRmokfneg2kwVW/KU5rOXrPSbF1qAKPMgNTqqROQQ==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.26.2", + "index-to-position": "^1.1.0", + "type-fest": "^4.39.1" + }, + "dependencies": { + "type-fest": { + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.40.1.tgz", + "integrity": "sha512-9YvLNnORDpI+vghLU/Nf+zSv0kL47KbVJ1o3sKgoTefl6i+zebxbiDQWoe/oWWqPhIgQdRZRT1KA9sCPL810SA==", + "dev": true + } + } + }, "path-exists": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", @@ -5220,12 +5605,24 @@ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", "dev": true }, + "picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true + }, "picomatch": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", "dev": true }, + "pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", + "dev": true + }, "prelude-ls": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", @@ -5285,6 +5682,12 @@ "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", "dev": true }, + "require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true + }, "resolve": { "version": "1.22.0", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.0.tgz", @@ -5477,16 +5880,6 @@ "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", "dev": true }, - "tiny-glob": { - "version": "0.2.9", - "resolved": "https://registry.npmjs.org/tiny-glob/-/tiny-glob-0.2.9.tgz", - "integrity": "sha512-g/55ssRPUjShh+xkfx9UPDXqhckHEsHr4Vd9zX55oSdGZc/MD0m3sferOkwWtp98bv+kcVfEHtRJgBVJzelrzg==", - "dev": true, - "requires": { - "globalyzer": "0.1.0", - "globrex": "^0.1.2" - } - }, "to-regex-range": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", @@ -5497,12 +5890,12 @@ } }, "ts-node": { - "version": "10.7.0", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.7.0.tgz", - "integrity": "sha512-TbIGS4xgJoX2i3do417KSaep1uRAW/Lu+WAL2doDHC0D6ummjirVOXU5/7aiZotbQ5p1Zp9tP7U6cYhA0O7M8A==", + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", "dev": true, "requires": { - "@cspotcode/source-map-support": "0.7.0", + "@cspotcode/source-map-support": "^0.8.0", "@tsconfig/node10": "^1.0.7", "@tsconfig/node12": "^1.0.7", "@tsconfig/node14": "^1.0.0", @@ -5513,7 +5906,7 @@ "create-require": "^1.1.0", "diff": "^4.0.1", "make-error": "^1.1.1", - "v8-compile-cache-lib": "^3.0.0", + "v8-compile-cache-lib": "^3.0.1", "yn": "3.1.1" } }, @@ -5566,9 +5959,9 @@ "dev": true }, "typescript": { - "version": "4.6.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.6.3.tgz", - "integrity": "sha512-yNIatDa5iaofVozS/uQJEl3JRWLKKGJKh6Yaiv0GLGSuhpFJe7P3SbHZ8/yjAHRQwKRoA6YZqlfjXWmVzoVSMw==", + "version": "5.8.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", + "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", "dev": true }, "unbox-primitive": { @@ -5583,15 +5976,6 @@ "which-boxed-primitive": "^1.0.2" } }, - "undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", - "dev": true, - "requires": { - "@fastify/busboy": "^2.0.0" - } - }, "uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -5601,6 +5985,12 @@ "punycode": "^2.1.0" } }, + "uri-js-replace": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/uri-js-replace/-/uri-js-replace-1.0.1.tgz", + "integrity": "sha512-W+C9NWNLFOoBI2QWDp4UT9pv65r2w5Cx+3sTYFvtMdDBxkKt1syCqsUdSFAChbEe1uK5TfS04wt/nGwmaeIQ0g==", + "dev": true + }, "v8-compile-cache": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", @@ -5608,9 +5998,9 @@ "dev": true }, "v8-compile-cache-lib": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.0.tgz", - "integrity": "sha512-mpSYqfsFvASnSn5qMiwrr4VKfumbPyONLCOPmsR3A6pTY/r0+tSaVbgPWSAIuzbk3lCTa+FForeTiO+wBQGkjA==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", "dev": true }, "which": { @@ -5682,6 +6072,12 @@ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "dev": true }, + "yaml-ast-parser": { + "version": "0.0.43", + "resolved": "https://registry.npmjs.org/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz", + "integrity": "sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A==", + "dev": true + }, "yargs": { "version": "16.2.0", "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", @@ -5706,9 +6102,9 @@ } }, "yargs-parser": { - "version": "21.0.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.0.1.tgz", - "integrity": "sha512-9BK1jFpLzJROCI5TzwZL/TU4gqjK5xiHV/RfWLOahrjAko/e4DJkRDZQXfvqAsiZzzYhgAzbgz6lg48jcm4GLg==", + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", "dev": true }, "yargs-unparser": { diff --git a/package.json b/package.json index e246096..ad37831 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "lint": "eslint \"lib/*.ts\"", "lint:fix": "eslint \"lib/*.ts\" --fix", "format": "prettier --write \"lib/*.ts\" \"examples/**/*.ts\"", - "schema": "node scripts/schema.mjs" + "schema": "ts-node scripts/schema.ts" }, "repository": { "type": "git", @@ -33,12 +33,12 @@ "eslint": "^8.12.0", "eslint-plugin-import": "^2.25.4", "mocha": "^10.0.0", - "openapi-typescript": "^5.4.1", + "openapi-typescript": "^7.6.1", "prettier": "^2.6.1", "rimraf": "^3.0.2", "sinon": "^14.0.0", - "ts-node": "^10.7.0", - "typescript": "^4.6.3" + "ts-node": "^10.9.2", + "typescript": "^5.8.3" }, "dependencies": { "axios": "^1.6.8", diff --git a/scripts/schema.mjs b/scripts/schema.mjs deleted file mode 100644 index 2bf922c..0000000 --- a/scripts/schema.mjs +++ /dev/null @@ -1,19 +0,0 @@ -import { pathToFileURL } from 'url'; -import { promises as fs } from 'fs'; - -async function run() { - const openapiTS = (await import('openapi-typescript')).default; - const localPath = pathToFileURL('../firefly/docs/swagger/swagger.yaml'); - const output = await openapiTS(localPath, { - formatter(node) { - if (node.type === undefined) { - return 'any'; - } - }, - }); - await fs.writeFile('lib/schema.ts', output); -} - -run().catch((err) => { - console.error('Error running script: ' + err); -}); diff --git a/scripts/schema.ts b/scripts/schema.ts new file mode 100644 index 0000000..c72c008 --- /dev/null +++ b/scripts/schema.ts @@ -0,0 +1,14 @@ +import { promises as fs } from 'fs'; +import openapiTS, { astToString } from 'openapi-typescript'; +import { pathToFileURL } from 'url'; + +async function run() { + const localPath = pathToFileURL('../firefly/doc-site/docs/swagger/swagger.yaml'); + console.log(`Generating types from ${localPath}`); + const output = await openapiTS(localPath.toString()); + await fs.writeFile('lib/schema.ts', astToString(output)); +} + +run().catch((err) => { + console.error('Error running script', err); +}); From e8acb05c81700da9465fd9f94358de1a68039491 Mon Sep 17 00:00:00 2001 From: Andrew Richardson Date: Wed, 30 Apr 2025 22:20:03 -0400 Subject: [PATCH 2/7] Update to fix vulnerabilities Signed-off-by: Andrew Richardson --- package-lock.json | 372 ++++++++++++++++++++++------------------------ 1 file changed, 178 insertions(+), 194 deletions(-) diff --git a/package-lock.json b/package-lock.json index d2d27b6..953bf42 100644 --- a/package-lock.json +++ b/package-lock.json @@ -634,12 +634,6 @@ "url": "https://opencollective.com/typescript-eslint" } }, - "node_modules/@ungap/promise-all-settled": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@ungap/promise-all-settled/-/promise-all-settled-1.1.2.tgz", - "integrity": "sha512-sL/cEvJWAnClXw0wHk85/2L0G6Sj8UB0Ctc1TEMbKSsmpRosqhwj9gWgFRZSrBr2f9tiXISwNhCPmlfqUqyb9Q==", - "dev": true - }, "node_modules/acorn": { "version": "8.7.0", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz", @@ -697,10 +691,11 @@ } }, "node_modules/ansi-colors": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", - "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", + "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } @@ -805,9 +800,10 @@ "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" }, "node_modules/axios": { - "version": "1.6.8", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.8.tgz", - "integrity": "sha512-v/ZHtJDU39mDpyBoFVkETcd/uNdxrWRrg3bKpOKzXFA6Bvqopts6ALSMU3y6ijYxbw2B+wPrIv46egTzJXCLGQ==", + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.9.0.tgz", + "integrity": "sha512-re4CqKTJaURpzbLHtIi6XpDv20/CnpXOtjRY5/CU32L8gU8ek9UIivcfvSWvmKEngmVbrUtPpdDwWDWL7DNHvg==", + "license": "MIT", "dependencies": { "follow-redirects": "^1.15.6", "form-data": "^4.0.0", @@ -1013,10 +1009,11 @@ "dev": true }, "node_modules/cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", "dev": true, + "license": "MIT", "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", @@ -1027,12 +1024,13 @@ } }, "node_modules/debug": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", - "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", + "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", "dev": true, + "license": "MIT", "dependencies": { - "ms": "2.1.2" + "ms": "^2.1.3" }, "engines": { "node": ">=6.0" @@ -2276,12 +2274,13 @@ } }, "node_modules/micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, + "license": "MIT", "dependencies": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" }, "engines": { @@ -2326,33 +2325,32 @@ "dev": true }, "node_modules/mocha": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.0.0.tgz", - "integrity": "sha512-0Wl+elVUD43Y0BqPZBzZt8Tnkw9CMUdNYnUsTfOM1vuhJVZL+kiesFYsqwBkEEuEixaiPe5ZQdqDgX2jddhmoA==", - "dev": true, - "dependencies": { - "@ungap/promise-all-settled": "1.1.2", - "ansi-colors": "4.1.1", - "browser-stdout": "1.3.1", - "chokidar": "3.5.3", - "debug": "4.3.4", - "diff": "5.0.0", - "escape-string-regexp": "4.0.0", - "find-up": "5.0.0", - "glob": "7.2.0", - "he": "1.2.0", - "js-yaml": "4.1.0", - "log-symbols": "4.1.0", - "minimatch": "5.0.1", - "ms": "2.1.3", - "nanoid": "3.3.3", - "serialize-javascript": "6.0.0", - "strip-json-comments": "3.1.1", - "supports-color": "8.1.1", - "workerpool": "6.2.1", - "yargs": "16.2.0", - "yargs-parser": "20.2.4", - "yargs-unparser": "2.0.0" + "version": "10.8.2", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.8.2.tgz", + "integrity": "sha512-VZlYo/WE8t1tstuRmqgeyBgCbJc/lEdopaa+axcKzTBJ+UIdlAB9XnmvTCAH4pwR4ElNInaedhEBmZD8iCSVEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-colors": "^4.1.3", + "browser-stdout": "^1.3.1", + "chokidar": "^3.5.3", + "debug": "^4.3.5", + "diff": "^5.2.0", + "escape-string-regexp": "^4.0.0", + "find-up": "^5.0.0", + "glob": "^8.1.0", + "he": "^1.2.0", + "js-yaml": "^4.1.0", + "log-symbols": "^4.1.0", + "minimatch": "^5.1.6", + "ms": "^2.1.3", + "serialize-javascript": "^6.0.2", + "strip-json-comments": "^3.1.1", + "supports-color": "^8.1.1", + "workerpool": "^6.5.1", + "yargs": "^16.2.0", + "yargs-parser": "^20.2.9", + "yargs-unparser": "^2.0.0" }, "bin": { "_mocha": "bin/_mocha", @@ -2360,10 +2358,6 @@ }, "engines": { "node": ">= 14.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/mochajs" } }, "node_modules/mocha/node_modules/brace-expansion": { @@ -2371,15 +2365,17 @@ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" } }, "node_modules/mocha/node_modules/diff": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-5.0.0.tgz", - "integrity": "sha512-/VTCrvm5Z0JGty/BWHljh+BAiw3IK+2j87NGMu8Nwc/f48WoDAC395uomO9ZD117ZOBaHmkX1oyLvkVM/aIT3w==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", + "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", "dev": true, + "license": "BSD-3-Clause", "engines": { "node": ">=0.3.1" } @@ -2400,6 +2396,27 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/mocha/node_modules/glob": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz", + "integrity": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^5.0.1", + "once": "^1.3.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/mocha/node_modules/locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", @@ -2416,10 +2433,11 @@ } }, "node_modules/mocha/node_modules/minimatch": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.0.1.tgz", - "integrity": "sha512-nLDxIFRyhDblz3qMuq+SoRZED4+miJ/G+tdDrjkkkRnjAsBexeGpgjLEQ0blJy7rHhR2b93rhQY4SvyWu9v03g==", + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^2.0.1" }, @@ -2427,12 +2445,6 @@ "node": ">=10" } }, - "node_modules/mocha/node_modules/ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "dev": true - }, "node_modules/mocha/node_modules/p-limit": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", @@ -2488,31 +2500,21 @@ } }, "node_modules/mocha/node_modules/yargs-parser": { - "version": "20.2.4", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.4.tgz", - "integrity": "sha512-WOkpgNhPTlE73h4VFAFsOnomJVaovO8VqLDzy5saChRBFQFBoMYirowyW+Q9HB4HFF4Z7VZTiG3iSzJJA29yRA==", + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", "dev": true, + "license": "ISC", "engines": { "node": ">=10" } }, "node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "node_modules/nanoid": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.3.tgz", - "integrity": "sha512-p1sjXuopFs0xg+fPASzQ28agW1oHD7xDsd9Xkf3T15H3c/cifrFHVwrh74PdoklAPi+i7MdRsE47vm2r6JoB+w==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", "dev": true, - "bin": { - "nanoid": "bin/nanoid.cjs" - }, - "engines": { - "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" - } + "license": "MIT" }, "node_modules/natural-compare": { "version": "1.4.0", @@ -2625,16 +2627,6 @@ "typescript": "^5.x" } }, - "node_modules/openapi-typescript/node_modules/ansi-colors": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", - "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=6" - } - }, "node_modules/openapi-typescript/node_modules/supports-color": { "version": "9.4.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-9.4.0.tgz", @@ -2775,10 +2767,11 @@ "dev": true }, "node_modules/path-to-regexp": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", - "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", + "integrity": "sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g==", "dev": true, + "license": "MIT", "dependencies": { "isarray": "0.0.1" } @@ -2884,6 +2877,7 @@ "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", "dev": true, + "license": "MIT", "dependencies": { "safe-buffer": "^5.1.0" } @@ -3023,7 +3017,8 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" }, "node_modules/semver": { "version": "7.6.0", @@ -3041,10 +3036,11 @@ } }, "node_modules/serialize-javascript": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.0.tgz", - "integrity": "sha512-Qr3TosvguFt8ePWqsvRfrKyQXIiW+nGbYpy8XK24NQHE83caxWt+mIymTT19DGFbNWNLfEwsrkSmN64lVWB9ag==", + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", + "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "randombytes": "^2.1.0" } @@ -3444,10 +3440,11 @@ } }, "node_modules/workerpool": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.2.1.tgz", - "integrity": "sha512-ILEIE97kDZvF9Wb9f6h5aXK4swSlKGUcOEGiIYb2OOu/IrDU9iwj0fD//SsA6E5ibwJxpEvhullJY4Sl4GcpAw==", - "dev": true + "version": "6.5.1", + "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.5.1.tgz", + "integrity": "sha512-Fs4dNYcsdpYSAfVxhnl1L5zTksjvOJxtC5hzMNl+1t9B8hTJTdKDyZ5ju7ztgPy+ft9tBFXoOlDNiOT9WUXZlA==", + "dev": true, + "license": "Apache-2.0" }, "node_modules/wrap-ansi": { "version": "7.0.0", @@ -4023,12 +4020,6 @@ "eslint-visitor-keys": "^3.0.0" } }, - "@ungap/promise-all-settled": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@ungap/promise-all-settled/-/promise-all-settled-1.1.2.tgz", - "integrity": "sha512-sL/cEvJWAnClXw0wHk85/2L0G6Sj8UB0Ctc1TEMbKSsmpRosqhwj9gWgFRZSrBr2f9tiXISwNhCPmlfqUqyb9Q==", - "dev": true - }, "acorn": { "version": "8.7.0", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz", @@ -4067,9 +4058,9 @@ } }, "ansi-colors": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.1.tgz", - "integrity": "sha512-JoX0apGbHaUJBNl6yF+p6JAFYZ666/hhCGKN5t9QFjbJQKUU/g8MNbFDbvfrgKXvI1QpZplPOnwIo99lX/AAmA==", + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", + "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", "dev": true }, "ansi-regex": { @@ -4145,9 +4136,9 @@ "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" }, "axios": { - "version": "1.6.8", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.8.tgz", - "integrity": "sha512-v/ZHtJDU39mDpyBoFVkETcd/uNdxrWRrg3bKpOKzXFA6Bvqopts6ALSMU3y6ijYxbw2B+wPrIv46egTzJXCLGQ==", + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.9.0.tgz", + "integrity": "sha512-re4CqKTJaURpzbLHtIi6XpDv20/CnpXOtjRY5/CU32L8gU8ek9UIivcfvSWvmKEngmVbrUtPpdDwWDWL7DNHvg==", "requires": { "follow-redirects": "^1.15.6", "form-data": "^4.0.0", @@ -4309,9 +4300,9 @@ "dev": true }, "cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", "dev": true, "requires": { "path-key": "^3.1.0", @@ -4320,12 +4311,12 @@ } }, "debug": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", - "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", + "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", "dev": true, "requires": { - "ms": "2.1.2" + "ms": "^2.1.3" } }, "decamelize": { @@ -5234,12 +5225,12 @@ "dev": true }, "micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, "requires": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" } }, @@ -5272,33 +5263,31 @@ "dev": true }, "mocha": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.0.0.tgz", - "integrity": "sha512-0Wl+elVUD43Y0BqPZBzZt8Tnkw9CMUdNYnUsTfOM1vuhJVZL+kiesFYsqwBkEEuEixaiPe5ZQdqDgX2jddhmoA==", - "dev": true, - "requires": { - "@ungap/promise-all-settled": "1.1.2", - "ansi-colors": "4.1.1", - "browser-stdout": "1.3.1", - "chokidar": "3.5.3", - "debug": "4.3.4", - "diff": "5.0.0", - "escape-string-regexp": "4.0.0", - "find-up": "5.0.0", - "glob": "7.2.0", - "he": "1.2.0", - "js-yaml": "4.1.0", - "log-symbols": "4.1.0", - "minimatch": "5.0.1", - "ms": "2.1.3", - "nanoid": "3.3.3", - "serialize-javascript": "6.0.0", - "strip-json-comments": "3.1.1", - "supports-color": "8.1.1", - "workerpool": "6.2.1", - "yargs": "16.2.0", - "yargs-parser": "20.2.4", - "yargs-unparser": "2.0.0" + "version": "10.8.2", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.8.2.tgz", + "integrity": "sha512-VZlYo/WE8t1tstuRmqgeyBgCbJc/lEdopaa+axcKzTBJ+UIdlAB9XnmvTCAH4pwR4ElNInaedhEBmZD8iCSVEg==", + "dev": true, + "requires": { + "ansi-colors": "^4.1.3", + "browser-stdout": "^1.3.1", + "chokidar": "^3.5.3", + "debug": "^4.3.5", + "diff": "^5.2.0", + "escape-string-regexp": "^4.0.0", + "find-up": "^5.0.0", + "glob": "^8.1.0", + "he": "^1.2.0", + "js-yaml": "^4.1.0", + "log-symbols": "^4.1.0", + "minimatch": "^5.1.6", + "ms": "^2.1.3", + "serialize-javascript": "^6.0.2", + "strip-json-comments": "^3.1.1", + "supports-color": "^8.1.1", + "workerpool": "^6.5.1", + "yargs": "^16.2.0", + "yargs-parser": "^20.2.9", + "yargs-unparser": "^2.0.0" }, "dependencies": { "brace-expansion": { @@ -5311,9 +5300,9 @@ } }, "diff": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-5.0.0.tgz", - "integrity": "sha512-/VTCrvm5Z0JGty/BWHljh+BAiw3IK+2j87NGMu8Nwc/f48WoDAC395uomO9ZD117ZOBaHmkX1oyLvkVM/aIT3w==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", + "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", "dev": true }, "find-up": { @@ -5326,6 +5315,19 @@ "path-exists": "^4.0.0" } }, + "glob": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz", + "integrity": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^5.0.1", + "once": "^1.3.0" + } + }, "locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", @@ -5336,20 +5338,14 @@ } }, "minimatch": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.0.1.tgz", - "integrity": "sha512-nLDxIFRyhDblz3qMuq+SoRZED4+miJ/G+tdDrjkkkRnjAsBexeGpgjLEQ0blJy7rHhR2b93rhQY4SvyWu9v03g==", + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", "dev": true, "requires": { "brace-expansion": "^2.0.1" } }, - "ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", - "dev": true - }, "p-limit": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", @@ -5384,23 +5380,17 @@ } }, "yargs-parser": { - "version": "20.2.4", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.4.tgz", - "integrity": "sha512-WOkpgNhPTlE73h4VFAFsOnomJVaovO8VqLDzy5saChRBFQFBoMYirowyW+Q9HB4HFF4Z7VZTiG3iSzJJA29yRA==", + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", "dev": true } } }, "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", - "dev": true - }, - "nanoid": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.3.tgz", - "integrity": "sha512-p1sjXuopFs0xg+fPASzQ28agW1oHD7xDsd9Xkf3T15H3c/cifrFHVwrh74PdoklAPi+i7MdRsE47vm2r6JoB+w==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", "dev": true }, "natural-compare": { @@ -5486,12 +5476,6 @@ "yargs-parser": "^21.1.1" }, "dependencies": { - "ansi-colors": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", - "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", - "dev": true - }, "supports-color": { "version": "9.4.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-9.4.0.tgz", @@ -5591,9 +5575,9 @@ "dev": true }, "path-to-regexp": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz", - "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==", + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", + "integrity": "sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g==", "dev": true, "requires": { "isarray": "0.0.1" @@ -5745,9 +5729,9 @@ } }, "serialize-javascript": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.0.tgz", - "integrity": "sha512-Qr3TosvguFt8ePWqsvRfrKyQXIiW+nGbYpy8XK24NQHE83caxWt+mIymTT19DGFbNWNLfEwsrkSmN64lVWB9ag==", + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", + "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", "dev": true, "requires": { "randombytes": "^2.1.0" @@ -6032,9 +6016,9 @@ "dev": true }, "workerpool": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.2.1.tgz", - "integrity": "sha512-ILEIE97kDZvF9Wb9f6h5aXK4swSlKGUcOEGiIYb2OOu/IrDU9iwj0fD//SsA6E5ibwJxpEvhullJY4Sl4GcpAw==", + "version": "6.5.1", + "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.5.1.tgz", + "integrity": "sha512-Fs4dNYcsdpYSAfVxhnl1L5zTksjvOJxtC5hzMNl+1t9B8hTJTdKDyZ5ju7ztgPy+ft9tBFXoOlDNiOT9WUXZlA==", "dev": true }, "wrap-ansi": { From 30ab663d1b733a048b295bd6ee83f585ba6ab105 Mon Sep 17 00:00:00 2001 From: Andrew Richardson Date: Wed, 30 Apr 2025 22:20:40 -0400 Subject: [PATCH 3/7] Re-generate schema for v1.3.3 Signed-off-by: Andrew Richardson --- lib/schema.ts | 60061 ++++++++++++++++++++++++++---------------------- 1 file changed, 32435 insertions(+), 27626 deletions(-) diff --git a/lib/schema.ts b/lib/schema.ts index f9f9cec..6efcadb 100644 --- a/lib/schema.ts +++ b/lib/schema.ts @@ -1,27685 +1,32494 @@ -/** - * This file was auto-generated by openapi-typescript. - * Do not make direct changes to the file. - */ - export interface paths { - "/apis": { - /** Gets a list of contract APIs that have been published */ - get: operations["getContractAPIs"]; - /** Creates and broadcasts a new custom smart contract API */ - post: operations["postNewContractAPI"]; - }; - "/apis/{apiName}": { - /** Gets information about a contract API, including the URLs for the OpenAPI Spec and Swagger UI for the API */ - get: operations["getContractAPIByName"]; - /** Delete a contract API */ - delete: operations["deleteContractAPI"]; - }; - "/apis/{apiName}/interface": { - /** Gets a contract interface for a contract API */ - get: operations["getContractAPIInterface"]; - }; - "/apis/{apiName}/invoke/{methodPath}": { - /** Invokes a method on a smart contract API. Performs a blockchain transaction. */ - post: operations["postContractAPIInvoke"]; - }; - "/apis/{apiName}/listeners/{eventPath}": { - /** Gets a list of contract listeners */ - get: operations["getContractAPIListeners"]; - /** Creates a new blockchain listener for events emitted by custom smart contracts */ - post: operations["postContractAPIListeners"]; - }; - "/apis/{apiName}/publish": { - /** Publish a contract API to all other members of the multiparty network */ - post: operations["postContractAPIPublish"]; - }; - "/apis/{apiName}/query/{methodPath}": { - /** Queries a method on a smart contract API. Performs a read-only query. */ - post: operations["postContractAPIQuery"]; - }; - "/apis/{id}": { - /** The ID of the contract API */ - put: operations["putContractAPI"]; - }; - "/batches": { - /** Gets a list of message batches */ - get: operations["getBatches"]; - }; - "/batches/{batchid}": { - /** Gets a message batch */ - get: operations["getBatchByID"]; - }; - "/blockchainevents": { - /** Gets a list of blockchain events */ - get: operations["getBlockchainEvents"]; - }; - "/blockchainevents/{id}": { - /** Gets a blockchain event */ - get: operations["getBlockchainEventByID"]; - }; - "/charts/histogram/{collection}": { - /** Gets a JSON object containing statistics data that can be used to build a graphical representation of recent activity in a given database collection */ - get: operations["getChartHistogram"]; - }; - "/contracts/deploy": { - /** Deploy a new smart contract */ - post: operations["postContractDeploy"]; - }; - "/contracts/interfaces": { - /** Gets a list of contract interfaces that have been published */ - get: operations["getContractInterfaces"]; - /** Creates and broadcasts a new custom smart contract interface */ - post: operations["postNewContractInterface"]; - }; - "/contracts/interfaces/{interfaceId}": { - /** Gets a contract interface by its ID */ - get: operations["getContractInterface"]; - /** Delete a contract interface */ - delete: operations["deleteContractInterface"]; - }; - "/contracts/interfaces/{name}/{version}": { - /** Gets a contract interface by its name and version */ - get: operations["getContractInterfaceByNameAndVersion"]; - }; - "/contracts/interfaces/{name}/{version}/publish": { - /** Publish a contract interface to all other members of the multiparty network */ - post: operations["postContractInterfacePublish"]; - }; - "/contracts/interfaces/generate": { - /** A convenience method to convert a blockchain specific smart contract format into a FireFly Interface format. The specific blockchain plugin in use must support this functionality. */ - post: operations["postGenerateContractInterface"]; - }; - "/contracts/invoke": { - /** Invokes a method on a smart contract. Performs a blockchain transaction. */ - post: operations["postContractInvoke"]; - }; - "/contracts/listeners": { - /** Gets a list of contract listeners */ - get: operations["getContractListeners"]; - /** Creates a new blockchain listener for events emitted by custom smart contracts */ - post: operations["postNewContractListener"]; - }; - "/contracts/listeners/{nameOrId}": { - /** Gets a contract listener by its name or ID */ - get: operations["getContractListenerByNameOrID"]; - /** Deletes a contract listener referenced by its name or its ID */ - delete: operations["deleteContractListener"]; - }; - "/contracts/query": { - /** Queries a method on a smart contract. Performs a read-only query. */ - post: operations["postContractQuery"]; - }; - "/data": { - /** Gets a list of data items */ - get: operations["getData"]; - /** Creates a new data item in this FireFly node */ - post: operations["postData"]; - }; - "/data/{dataid}": { - /** Gets a data item by its ID, including metadata about this item */ - get: operations["getDataByID"]; - /** Deletes a data item by its ID, including metadata about this item */ - delete: operations["deleteData"]; - }; - "/data/{dataid}/blob": { - /** Downloads the original file that was previously uploaded or received */ - get: operations["getDataBlob"]; - }; - "/data/{dataid}/blob/publish": { - /** Publishes the binary blob attachment stored in your local data exchange, to shared storage */ - post: operations["postDataBlobPublish"]; - }; - "/data/{dataid}/messages": { - /** Gets a list of the messages associated with a data item */ - get: operations["getDataMsgs"]; - }; - "/data/{dataid}/value": { - /** Downloads the JSON value of the data resource, without the associated metadata */ - get: operations["getDataValue"]; - }; - "/data/{dataid}/value/publish": { - /** Publishes the JSON value from the specified data resource, to shared storage */ - post: operations["postDataValuePublish"]; - }; - "/datasubpaths/{parent}": { - /** Gets a list of path names of named blob data, underneath a given parent path ('/' path prefixes are automatically pre-prepended) */ - get: operations["getDataSubPaths"]; - }; - "/datatypes": { - /** Gets a list of datatypes that have been published */ - get: operations["getDatatypes"]; - /** Creates and broadcasts a new datatype */ - post: operations["postNewDatatype"]; - }; - "/datatypes/{name}/{version}": { - /** Gets a datatype by its name and version */ - get: operations["getDatatypeByName"]; - }; - "/events": { - /** Gets a list of events */ - get: operations["getEvents"]; - }; - "/events/{eid}": { - /** Gets an event by its ID */ - get: operations["getEventByID"]; - }; - "/groups": { - /** Gets a list of groups */ - get: operations["getGroups"]; - }; - "/groups/{hash}": { - /** Gets a group by its ID (hash) */ - get: operations["getGroupByHash"]; - }; - "/identities": { - /** Gets a list of all identities that have been registered in the namespace */ - get: operations["getIdentities"]; - /** Registers a new identity in the network */ - post: operations["postNewIdentity"]; - }; - "/identities/{did}": { - /** Gets an identity by its DID */ - get: operations["getIdentityByDID"]; - }; - "/identities/{iid}": { - /** Gets an identity by its ID */ - get: operations["getIdentityByID"]; - /** Updates an identity */ - patch: operations["patchUpdateIdentity"]; - }; - "/identities/{iid}/did": { - /** Gets the DID for an identity based on its ID */ - get: operations["getIdentityDID"]; - }; - "/identities/{iid}/verifiers": { - /** Gets the verifiers for an identity */ - get: operations["getIdentityVerifiers"]; - }; - "/messages": { - /** Gets a list of messages */ - get: operations["getMsgs"]; - }; - "/messages/{msgid}": { - /** Gets a message by its ID */ - get: operations["getMsgByID"]; - }; - "/messages/{msgid}/data": { - /** Gets the list of data items that are attached to a message */ - get: operations["getMsgData"]; - }; - "/messages/{msgid}/events": { - /** Gets the list of events for a message */ - get: operations["getMsgEvents"]; - }; - "/messages/{msgid}/transaction": { - /** Gets the transaction for a message */ - get: operations["getMsgTxn"]; - }; - "/messages/broadcast": { - /** Broadcasts a message to all members in the network */ - post: operations["postNewMessageBroadcast"]; - }; - "/messages/private": { - /** Privately sends a message to one or more members in the network */ - post: operations["postNewMessagePrivate"]; - }; - "/messages/requestreply": { - /** Sends a message with a blocking HTTP request, waits for a reply to that message, then sends the reply as the HTTP response. */ - post: operations["postNewMessageRequestReply"]; - }; - "/namespaces": { - /** Gets a list of namespaces */ - get: operations["getNamespaces"]; - }; - "/namespaces/{ns}": { - /** Gets a namespace */ - get: operations["getNamespace"]; - }; - "/namespaces/{ns}/apis": { - /** Gets a list of contract APIs that have been published */ - get: operations["getContractAPIsNamespace"]; - /** Creates and broadcasts a new custom smart contract API */ - post: operations["postNewContractAPINamespace"]; - }; - "/namespaces/{ns}/apis/{apiName}": { - /** Gets information about a contract API, including the URLs for the OpenAPI Spec and Swagger UI for the API */ - get: operations["getContractAPIByNameNamespace"]; - /** Delete a contract API */ - delete: operations["deleteContractAPINamespace"]; - }; - "/namespaces/{ns}/apis/{apiName}/interface": { - /** Gets a contract interface for a contract API */ - get: operations["getContractAPIInterfaceNamespace"]; - }; - "/namespaces/{ns}/apis/{apiName}/invoke/{methodPath}": { - /** Invokes a method on a smart contract API. Performs a blockchain transaction. */ - post: operations["postContractAPIInvokeNamespace"]; - }; - "/namespaces/{ns}/apis/{apiName}/listeners/{eventPath}": { - /** Gets a list of contract listeners */ - get: operations["getContractAPIListenersNamespace"]; - /** Creates a new blockchain listener for events emitted by custom smart contracts */ - post: operations["postContractAPIListenersNamespace"]; - }; - "/namespaces/{ns}/apis/{apiName}/publish": { - /** Publish a contract API to all other members of the multiparty network */ - post: operations["postContractAPIPublishNamespace"]; - }; - "/namespaces/{ns}/apis/{apiName}/query/{methodPath}": { - /** Queries a method on a smart contract API. Performs a read-only query. */ - post: operations["postContractAPIQueryNamespace"]; - }; - "/namespaces/{ns}/apis/{id}": { - /** The ID of the contract API */ - put: operations["putContractAPINamespace"]; - }; - "/namespaces/{ns}/batches": { - /** Gets a list of message batches */ - get: operations["getBatchesNamespace"]; - }; - "/namespaces/{ns}/batches/{batchid}": { - /** Gets a message batch */ - get: operations["getBatchByIDNamespace"]; - }; - "/namespaces/{ns}/blockchainevents": { - /** Gets a list of blockchain events */ - get: operations["getBlockchainEventsNamespace"]; - }; - "/namespaces/{ns}/blockchainevents/{id}": { - /** Gets a blockchain event */ - get: operations["getBlockchainEventByIDNamespace"]; - }; - "/namespaces/{ns}/charts/histogram/{collection}": { - /** Gets a JSON object containing statistics data that can be used to build a graphical representation of recent activity in a given database collection */ - get: operations["getChartHistogramNamespace"]; - }; - "/namespaces/{ns}/contracts/deploy": { - /** Deploy a new smart contract */ - post: operations["postContractDeployNamespace"]; - }; - "/namespaces/{ns}/contracts/interfaces": { - /** Gets a list of contract interfaces that have been published */ - get: operations["getContractInterfacesNamespace"]; - /** Creates and broadcasts a new custom smart contract interface */ - post: operations["postNewContractInterfaceNamespace"]; - }; - "/namespaces/{ns}/contracts/interfaces/{interfaceId}": { - /** Gets a contract interface by its ID */ - get: operations["getContractInterfaceNamespace"]; - /** Delete a contract interface */ - delete: operations["deleteContractInterfaceNamespace"]; - }; - "/namespaces/{ns}/contracts/interfaces/{name}/{version}": { - /** Gets a contract interface by its name and version */ - get: operations["getContractInterfaceByNameAndVersionNamespace"]; - }; - "/namespaces/{ns}/contracts/interfaces/{name}/{version}/publish": { - /** Publish a contract interface to all other members of the multiparty network */ - post: operations["postContractInterfacePublishNamespace"]; - }; - "/namespaces/{ns}/contracts/interfaces/generate": { - /** A convenience method to convert a blockchain specific smart contract format into a FireFly Interface format. The specific blockchain plugin in use must support this functionality. */ - post: operations["postGenerateContractInterfaceNamespace"]; - }; - "/namespaces/{ns}/contracts/invoke": { - /** Invokes a method on a smart contract. Performs a blockchain transaction. */ - post: operations["postContractInvokeNamespace"]; - }; - "/namespaces/{ns}/contracts/listeners": { - /** Gets a list of contract listeners */ - get: operations["getContractListenersNamespace"]; - /** Creates a new blockchain listener for events emitted by custom smart contracts */ - post: operations["postNewContractListenerNamespace"]; - }; - "/namespaces/{ns}/contracts/listeners/{nameOrId}": { - /** Gets a contract listener by its name or ID */ - get: operations["getContractListenerByNameOrIDNamespace"]; - /** Deletes a contract listener referenced by its name or its ID */ - delete: operations["deleteContractListenerNamespace"]; - }; - "/namespaces/{ns}/contracts/query": { - /** Queries a method on a smart contract. Performs a read-only query. */ - post: operations["postContractQueryNamespace"]; - }; - "/namespaces/{ns}/data": { - /** Gets a list of data items */ - get: operations["getDataNamespace"]; - /** Creates a new data item in this FireFly node */ - post: operations["postDataNamespace"]; - }; - "/namespaces/{ns}/data/{dataid}": { - /** Gets a data item by its ID, including metadata about this item */ - get: operations["getDataByIDNamespace"]; - /** Deletes a data item by its ID, including metadata about this item */ - delete: operations["deleteDataNamespace"]; - }; - "/namespaces/{ns}/data/{dataid}/blob": { - /** Downloads the original file that was previously uploaded or received */ - get: operations["getDataBlobNamespace"]; - }; - "/namespaces/{ns}/data/{dataid}/blob/publish": { - /** Publishes the binary blob attachment stored in your local data exchange, to shared storage */ - post: operations["postDataBlobPublishNamespace"]; - }; - "/namespaces/{ns}/data/{dataid}/messages": { - /** Gets a list of the messages associated with a data item */ - get: operations["getDataMsgsNamespace"]; - }; - "/namespaces/{ns}/data/{dataid}/value": { - /** Downloads the JSON value of the data resource, without the associated metadata */ - get: operations["getDataValueNamespace"]; - }; - "/namespaces/{ns}/data/{dataid}/value/publish": { - /** Publishes the JSON value from the specified data resource, to shared storage */ - post: operations["postDataValuePublishNamespace"]; - }; - "/namespaces/{ns}/datasubpaths/{parent}": { - /** Gets a list of path names of named blob data, underneath a given parent path ('/' path prefixes are automatically pre-prepended) */ - get: operations["getDataSubPathsNamespace"]; - }; - "/namespaces/{ns}/datatypes": { - /** Gets a list of datatypes that have been published */ - get: operations["getDatatypesNamespace"]; - /** Creates and broadcasts a new datatype */ - post: operations["postNewDatatypeNamespace"]; - }; - "/namespaces/{ns}/datatypes/{name}/{version}": { - /** Gets a datatype by its name and version */ - get: operations["getDatatypeByNameNamespace"]; - }; - "/namespaces/{ns}/events": { - /** Gets a list of events */ - get: operations["getEventsNamespace"]; - }; - "/namespaces/{ns}/events/{eid}": { - /** Gets an event by its ID */ - get: operations["getEventByIDNamespace"]; - }; - "/namespaces/{ns}/groups": { - /** Gets a list of groups */ - get: operations["getGroupsNamespace"]; - }; - "/namespaces/{ns}/groups/{hash}": { - /** Gets a group by its ID (hash) */ - get: operations["getGroupByHashNamespace"]; - }; - "/namespaces/{ns}/identities": { - /** Gets a list of all identities that have been registered in the namespace */ - get: operations["getIdentitiesNamespace"]; - /** Registers a new identity in the network */ - post: operations["postNewIdentityNamespace"]; - }; - "/namespaces/{ns}/identities/{did}": { - /** Gets an identity by its DID */ - get: operations["getIdentityByDIDNamespace"]; - }; - "/namespaces/{ns}/identities/{iid}": { - /** Gets an identity by its ID */ - get: operations["getIdentityByIDNamespace"]; - /** Updates an identity */ - patch: operations["patchUpdateIdentityNamespace"]; - }; - "/namespaces/{ns}/identities/{iid}/did": { - /** Gets the DID for an identity based on its ID */ - get: operations["getIdentityDIDNamespace"]; - }; - "/namespaces/{ns}/identities/{iid}/verifiers": { - /** Gets the verifiers for an identity */ - get: operations["getIdentityVerifiersNamespace"]; - }; - "/namespaces/{ns}/messages": { - /** Gets a list of messages */ - get: operations["getMsgsNamespace"]; - }; - "/namespaces/{ns}/messages/{msgid}": { - /** Gets a message by its ID */ - get: operations["getMsgByIDNamespace"]; - }; - "/namespaces/{ns}/messages/{msgid}/data": { - /** Gets the list of data items that are attached to a message */ - get: operations["getMsgDataNamespace"]; - }; - "/namespaces/{ns}/messages/{msgid}/events": { - /** Gets the list of events for a message */ - get: operations["getMsgEventsNamespace"]; - }; - "/namespaces/{ns}/messages/{msgid}/transaction": { - /** Gets the transaction for a message */ - get: operations["getMsgTxnNamespace"]; - }; - "/namespaces/{ns}/messages/broadcast": { - /** Broadcasts a message to all members in the network */ - post: operations["postNewMessageBroadcastNamespace"]; - }; - "/namespaces/{ns}/messages/private": { - /** Privately sends a message to one or more members in the network */ - post: operations["postNewMessagePrivateNamespace"]; - }; - "/namespaces/{ns}/messages/requestreply": { - /** Sends a message with a blocking HTTP request, waits for a reply to that message, then sends the reply as the HTTP response. */ - post: operations["postNewMessageRequestReplyNamespace"]; - }; - "/namespaces/{ns}/network/action": { - /** Notify all nodes in the network of a new governance action */ - post: operations["postNetworkActionNamespace"]; - }; - "/namespaces/{ns}/network/diddocs/{did}": { - /** Gets a DID document by its DID */ - get: operations["getNetworkDIDDocByDIDNamespace"]; - }; - "/namespaces/{ns}/network/identities": { - /** Gets the list of identities in the network (deprecated - use /identities instead of /network/identities */ - get: operations["getNetworkIdentitiesNamespace"]; - }; - "/namespaces/{ns}/network/identities/{did}": { - /** Gets an identity by its DID */ - get: operations["getNetworkIdentityByDIDNamespace"]; - }; - "/namespaces/{ns}/network/nodes": { - /** Gets a list of nodes in the network */ - get: operations["getNetworkNodesNamespace"]; - }; - "/namespaces/{ns}/network/nodes/{nameOrId}": { - /** Gets information about a specific node in the network */ - get: operations["getNetworkNodeNamespace"]; - }; - "/namespaces/{ns}/network/nodes/self": { - /** Instructs this FireFly node to register itself on the network */ - post: operations["postNodesSelfNamespace"]; - }; - "/namespaces/{ns}/network/organizations": { - /** Gets a list of orgs in the network */ - get: operations["getNetworkOrgsNamespace"]; - /** Registers a new org in the network */ - post: operations["postNewOrganizationNamespace"]; - }; - "/namespaces/{ns}/network/organizations/{nameOrId}": { - /** Gets information about a specific org in the network */ - get: operations["getNetworkOrgNamespace"]; - }; - "/namespaces/{ns}/network/organizations/self": { - /** Instructs this FireFly node to register its org on the network */ - post: operations["postNewOrganizationSelfNamespace"]; - }; - "/namespaces/{ns}/nextpins": { - /** Queries the list of next-pins that determine the next masked message sequence for each member of a privacy group, on each context/topic */ - get: operations["getNextPinsNamespace"]; - }; - "/namespaces/{ns}/operations": { - /** Gets a a list of operations */ - get: operations["getOpsNamespace"]; - }; - "/namespaces/{ns}/operations/{opid}": { - /** Gets an operation by ID */ - get: operations["getOpByIDNamespace"]; - }; - "/namespaces/{ns}/operations/{opid}/retry": { - /** Retries a failed operation */ - post: operations["postOpRetryNamespace"]; - }; - "/namespaces/{ns}/pins": { - /** Queries the list of pins received from the blockchain */ - get: operations["getPinsNamespace"]; - }; - "/namespaces/{ns}/pins/rewind": { - /** Force a rewind of the event aggregator to a previous position, to re-evaluate (and possibly dispatch) that pin and others after it. Only accepts a sequence or batch ID for a currently undispatched pin */ - post: operations["postPinsRewindNamespace"]; - }; - "/namespaces/{ns}/status": { - /** Gets the status of this namespace */ - get: operations["getStatusNamespace"]; - }; - "/namespaces/{ns}/status/batchmanager": { - /** Gets the status of the batch manager */ - get: operations["getStatusBatchManagerNamespace"]; - }; - "/namespaces/{ns}/subscriptions": { - /** Gets a list of subscriptions */ - get: operations["getSubscriptionsNamespace"]; - /** Update an existing subscription */ - put: operations["putSubscriptionNamespace"]; - /** Creates a new subscription for an application to receive events from FireFly */ - post: operations["postNewSubscriptionNamespace"]; - }; - "/namespaces/{ns}/subscriptions/{subid}": { - /** Gets a subscription by its ID */ - get: operations["getSubscriptionByIDNamespace"]; - /** Deletes a subscription */ - delete: operations["deleteSubscriptionNamespace"]; - }; - "/namespaces/{ns}/tokens/accounts": { - /** Gets a list of token accounts */ - get: operations["getTokenAccountsNamespace"]; - }; - "/namespaces/{ns}/tokens/accounts/{key}/pools": { - /** Gets a list of token pools that contain a given token account key */ - get: operations["getTokenAccountPoolsNamespace"]; - }; - "/namespaces/{ns}/tokens/approvals": { - /** Gets a list of token approvals */ - get: operations["getTokenApprovalsNamespace"]; - /** Creates a token approval */ - post: operations["postTokenApprovalNamespace"]; - }; - "/namespaces/{ns}/tokens/balances": { - /** Gets a list of token balances */ - get: operations["getTokenBalancesNamespace"]; - }; - "/namespaces/{ns}/tokens/burn": { - /** Burns some tokens */ - post: operations["postTokenBurnNamespace"]; - }; - "/namespaces/{ns}/tokens/connectors": { - /** Gets the list of token connectors currently in use */ - get: operations["getTokenConnectorsNamespace"]; - }; - "/namespaces/{ns}/tokens/mint": { - /** Mints some tokens */ - post: operations["postTokenMintNamespace"]; - }; - "/namespaces/{ns}/tokens/pools": { - /** Gets a list of token pools */ - get: operations["getTokenPoolsNamespace"]; - /** Creates a new token pool */ - post: operations["postTokenPoolNamespace"]; - }; - "/namespaces/{ns}/tokens/pools/{nameOrId}": { - /** Gets a token pool by its name or its ID */ - get: operations["getTokenPoolByNameOrIDNamespace"]; - /** Delete a token pool */ - delete: operations["deleteTokenPoolNamespace"]; - }; - "/namespaces/{ns}/tokens/pools/{nameOrId}/publish": { - /** Publish a token pool to all other members of the multiparty network */ - post: operations["postTokenPoolPublishNamespace"]; - }; - "/namespaces/{ns}/tokens/transfers": { - /** Gets a list of token transfers */ - get: operations["getTokenTransfersNamespace"]; - /** Transfers some tokens */ - post: operations["postTokenTransferNamespace"]; - }; - "/namespaces/{ns}/tokens/transfers/{transferId}": { - /** Gets a token transfer by its ID */ - get: operations["getTokenTransferByIDNamespace"]; - }; - "/namespaces/{ns}/transactions": { - /** Gets a list of transactions */ - get: operations["getTxnsNamespace"]; - }; - "/namespaces/{ns}/transactions/{txnid}": { - /** Gets a transaction by its ID */ - get: operations["getTxnByIDNamespace"]; - }; - "/namespaces/{ns}/transactions/{txnid}/blockchainevents": { - /** Gets a list blockchain events for a specific transaction */ - get: operations["getTxnBlockchainEventsNamespace"]; - }; - "/namespaces/{ns}/transactions/{txnid}/operations": { - /** Gets a list of operations in a specific transaction */ - get: operations["getTxnOpsNamespace"]; - }; - "/namespaces/{ns}/transactions/{txnid}/status": { - /** Gets the status of a transaction */ - get: operations["getTxnStatusNamespace"]; - }; - "/namespaces/{ns}/verifiers": { - /** Gets a list of verifiers */ - get: operations["getVerifiersNamespace"]; - }; - "/namespaces/{ns}/verifiers/{hash}": { - /** Gets a verifier by its hash */ - get: operations["getVerifierByIDNamespace"]; - }; - "/namespaces/{ns}/verifiers/resolve": { - /** Resolves an input key to a signing key */ - post: operations["postVerifiersResolveNamespace"]; - }; - "/network/action": { - /** Notify all nodes in the network of a new governance action */ - post: operations["postNetworkAction"]; - }; - "/network/diddocs/{did}": { - /** Gets a DID document by its DID */ - get: operations["getNetworkDIDDocByDID"]; - }; - "/network/identities": { - /** Gets the list of identities in the network (deprecated - use /identities instead of /network/identities */ - get: operations["getNetworkIdentities"]; - }; - "/network/identities/{did}": { - /** Gets an identity by its DID */ - get: operations["getNetworkIdentityByDID"]; - }; - "/network/nodes": { - /** Gets a list of nodes in the network */ - get: operations["getNetworkNodes"]; - }; - "/network/nodes/{nameOrId}": { - /** Gets information about a specific node in the network */ - get: operations["getNetworkNode"]; - }; - "/network/nodes/self": { - /** Instructs this FireFly node to register itself on the network */ - post: operations["postNodesSelf"]; - }; - "/network/organizations": { - /** Gets a list of orgs in the network */ - get: operations["getNetworkOrgs"]; - /** Registers a new org in the network */ - post: operations["postNewOrganization"]; - }; - "/network/organizations/{nameOrId}": { - /** Gets information about a specific org in the network */ - get: operations["getNetworkOrg"]; - }; - "/network/organizations/self": { - /** Instructs this FireFly node to register its org on the network */ - post: operations["postNewOrganizationSelf"]; - }; - "/nextpins": { - /** Queries the list of next-pins that determine the next masked message sequence for each member of a privacy group, on each context/topic */ - get: operations["getNextPins"]; - }; - "/operations": { - /** Gets a a list of operations */ - get: operations["getOps"]; - }; - "/operations/{opid}": { - /** Gets an operation by ID */ - get: operations["getOpByID"]; - }; - "/operations/{opid}/retry": { - /** Retries a failed operation */ - post: operations["postOpRetry"]; - }; - "/pins": { - /** Queries the list of pins received from the blockchain */ - get: operations["getPins"]; - }; - "/pins/rewind": { - /** Force a rewind of the event aggregator to a previous position, to re-evaluate (and possibly dispatch) that pin and others after it. Only accepts a sequence or batch ID for a currently undispatched pin */ - post: operations["postPinsRewind"]; - }; - "/status": { - /** Gets the status of this namespace */ - get: operations["getStatus"]; - }; - "/status/batchmanager": { - /** Gets the status of the batch manager */ - get: operations["getStatusBatchManager"]; - }; - "/subscriptions": { - /** Gets a list of subscriptions */ - get: operations["getSubscriptions"]; - /** Update an existing subscription */ - put: operations["putSubscription"]; - /** Creates a new subscription for an application to receive events from FireFly */ - post: operations["postNewSubscription"]; - }; - "/subscriptions/{subid}": { - /** Gets a subscription by its ID */ - get: operations["getSubscriptionByID"]; - /** Deletes a subscription */ - delete: operations["deleteSubscription"]; - }; - "/tokens/accounts": { - /** Gets a list of token accounts */ - get: operations["getTokenAccounts"]; - }; - "/tokens/accounts/{key}/pools": { - /** Gets a list of token pools that contain a given token account key */ - get: operations["getTokenAccountPools"]; - }; - "/tokens/approvals": { - /** Gets a list of token approvals */ - get: operations["getTokenApprovals"]; - /** Creates a token approval */ - post: operations["postTokenApproval"]; - }; - "/tokens/balances": { - /** Gets a list of token balances */ - get: operations["getTokenBalances"]; - }; - "/tokens/burn": { - /** Burns some tokens */ - post: operations["postTokenBurn"]; - }; - "/tokens/connectors": { - /** Gets the list of token connectors currently in use */ - get: operations["getTokenConnectors"]; - }; - "/tokens/mint": { - /** Mints some tokens */ - post: operations["postTokenMint"]; - }; - "/tokens/pools": { - /** Gets a list of token pools */ - get: operations["getTokenPools"]; - /** Creates a new token pool */ - post: operations["postTokenPool"]; - }; - "/tokens/pools/{nameOrId}": { - /** Gets a token pool by its name or its ID */ - get: operations["getTokenPoolByNameOrID"]; - /** Delete a token pool */ - delete: operations["deleteTokenPool"]; - }; - "/tokens/pools/{nameOrId}/publish": { - /** Publish a token pool to all other members of the multiparty network */ - post: operations["postTokenPoolPublish"]; - }; - "/tokens/transfers": { - /** Gets a list of token transfers */ - get: operations["getTokenTransfers"]; - /** Transfers some tokens */ - post: operations["postTokenTransfer"]; - }; - "/tokens/transfers/{transferId}": { - /** Gets a token transfer by its ID */ - get: operations["getTokenTransferByID"]; - }; - "/transactions": { - /** Gets a list of transactions */ - get: operations["getTxns"]; - }; - "/transactions/{txnid}": { - /** Gets a transaction by its ID */ - get: operations["getTxnByID"]; - }; - "/transactions/{txnid}/blockchainevents": { - /** Gets a list blockchain events for a specific transaction */ - get: operations["getTxnBlockchainEvents"]; - }; - "/transactions/{txnid}/operations": { - /** Gets a list of operations in a specific transaction */ - get: operations["getTxnOps"]; - }; - "/transactions/{txnid}/status": { - /** Gets the status of a transaction */ - get: operations["getTxnStatus"]; - }; - "/verifiers": { - /** Gets a list of verifiers */ - get: operations["getVerifiers"]; - }; - "/verifiers/{hash}": { - /** Gets a verifier by its hash */ - get: operations["getVerifierByID"]; - }; - "/verifiers/resolve": { - /** Resolves an input key to a signing key */ - post: operations["postVerifiersResolve"]; - }; - "/websockets": { - /** Gets a list of the current WebSocket connections to this node */ - get: operations["getWebSockets"]; - }; + "/apis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of contract APIs that have been published */ + get: operations["getContractAPIs"]; + put?: never; + /** @description Creates and broadcasts a new custom smart contract API */ + post: operations["postNewContractAPI"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/apis/{apiName}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets information about a contract API, including the URLs for the OpenAPI Spec and Swagger UI for the API */ + get: operations["getContractAPIByName"]; + /** @description The ID of the contract API */ + put: operations["putContractAPI"]; + post?: never; + /** @description Delete a contract API */ + delete: operations["deleteContractAPI"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/apis/{apiName}/interface": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a contract interface for a contract API */ + get: operations["getContractAPIInterface"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/apis/{apiName}/invoke/{methodPath}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Invokes a method on a smart contract API. Performs a blockchain transaction. */ + post: operations["postContractAPIInvoke"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/apis/{apiName}/listeners/{eventPath}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of contract listeners */ + get: operations["getContractAPIListeners"]; + put?: never; + /** @description Creates a new blockchain listener for events emitted by custom smart contracts */ + post: operations["postContractAPIListeners"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/apis/{apiName}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publish a contract API to all other members of the multiparty network */ + post: operations["postContractAPIPublish"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/apis/{apiName}/query/{methodPath}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Queries a method on a smart contract API. Performs a read-only query. */ + post: operations["postContractAPIQuery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/batches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of message batches */ + get: operations["getBatches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/batches/{batchid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a message batch */ + get: operations["getBatchByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/batches/{batchid}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Cancel a batch that has failed to dispatch */ + post: operations["postBatchCancel"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/blockchainevents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of blockchain events */ + get: operations["getBlockchainEvents"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/blockchainevents/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a blockchain event */ + get: operations["getBlockchainEventByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/charts/histogram/{collection}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a JSON object containing statistics data that can be used to build a graphical representation of recent activity in a given database collection */ + get: operations["getChartHistogram"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/deploy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Deploy a new smart contract */ + post: operations["postContractDeploy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/interfaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of contract interfaces that have been published */ + get: operations["getContractInterfaces"]; + put?: never; + /** @description Creates and broadcasts a new custom smart contract interface */ + post: operations["postNewContractInterface"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/interfaces/{interfaceId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a contract interface by its ID */ + get: operations["getContractInterface"]; + put?: never; + post?: never; + /** @description Delete a contract interface */ + delete: operations["deleteContractInterface"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/interfaces/{name}/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a contract interface by its name and version */ + get: operations["getContractInterfaceByNameAndVersion"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/interfaces/{name}/{version}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publish a contract interface to all other members of the multiparty network */ + post: operations["postContractInterfacePublish"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/interfaces/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description A convenience method to convert a blockchain specific smart contract format into a FireFly Interface format. The specific blockchain plugin in use must support this functionality. */ + post: operations["postGenerateContractInterface"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/invoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Invokes a method on a smart contract. Performs a blockchain transaction. */ + post: operations["postContractInvoke"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/listeners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of contract listeners */ + get: operations["getContractListeners"]; + put?: never; + /** @description Creates a new blockchain listener for events emitted by custom smart contracts */ + post: operations["postNewContractListener"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/listeners/{nameOrId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a contract listener by its name or ID */ + get: operations["getContractListenerByNameOrID"]; + put?: never; + post?: never; + /** @description Deletes a contract listener referenced by its name or its ID */ + delete: operations["deleteContractListener"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/listeners/signature": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Calculates the hash of a blockchain listener filters and events */ + post: operations["postContractListenerSignature"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/contracts/query": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Queries a method on a smart contract. Performs a read-only query. */ + post: operations["postContractQuery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of data items */ + get: operations["getData"]; + put?: never; + /** @description Creates a new data item in this FireFly node */ + post: operations["postData"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/data/{dataid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a data item by its ID, including metadata about this item */ + get: operations["getDataByID"]; + put?: never; + post?: never; + /** @description Deletes a data item by its ID, including metadata about this item */ + delete: operations["deleteData"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/data/{dataid}/blob": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Downloads the original file that was previously uploaded or received */ + get: operations["getDataBlob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/data/{dataid}/blob/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publishes the binary blob attachment stored in your local data exchange, to shared storage */ + post: operations["postDataBlobPublish"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/data/{dataid}/messages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of the messages associated with a data item */ + get: operations["getDataMsgs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/data/{dataid}/value": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Downloads the JSON value of the data resource, without the associated metadata */ + get: operations["getDataValue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/data/{dataid}/value/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publishes the JSON value from the specified data resource, to shared storage */ + post: operations["postDataValuePublish"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/datasubpaths/{parent}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of path names of named blob data, underneath a given parent path ('/' path prefixes are automatically pre-prepended) */ + get: operations["getDataSubPaths"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/datatypes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of datatypes that have been published */ + get: operations["getDatatypes"]; + put?: never; + /** @description Creates and broadcasts a new datatype */ + post: operations["postNewDatatype"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/datatypes/{name}/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a datatype by its name and version */ + get: operations["getDatatypeByName"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of events */ + get: operations["getEvents"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/events/{eid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets an event by its ID */ + get: operations["getEventByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of groups */ + get: operations["getGroups"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/groups/{hash}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a group by its ID (hash) */ + get: operations["getGroupByHash"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/identities": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of all identities that have been registered in the namespace */ + get: operations["getIdentities"]; + put?: never; + /** @description Registers a new identity in the network */ + post: operations["postNewIdentity"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/identities/{did}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets an identity by its ID */ + get: operations["getIdentityByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** @description Updates an identity */ + patch: operations["patchUpdateIdentity"]; + trace?: never; + }; + "/identities/{iid}/did": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the DID for an identity based on its ID */ + get: operations["getIdentityDID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/identities/{iid}/verifiers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the verifiers for an identity */ + get: operations["getIdentityVerifiers"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/messages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of messages */ + get: operations["getMsgs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/messages/{msgid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a message by its ID */ + get: operations["getMsgByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/messages/{msgid}/data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the list of data items that are attached to a message */ + get: operations["getMsgData"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/messages/{msgid}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the list of events for a message */ + get: operations["getMsgEvents"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/messages/{msgid}/transaction": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the transaction for a message */ + get: operations["getMsgTxn"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/messages/broadcast": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Broadcasts a message to all members in the network */ + post: operations["postNewMessageBroadcast"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/messages/private": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Privately sends a message to one or more members in the network */ + post: operations["postNewMessagePrivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/messages/requestreply": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Sends a message with a blocking HTTP request, waits for a reply to that message, then sends the reply as the HTTP response. */ + post: operations["postNewMessageRequestReply"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of namespaces */ + get: operations["getNamespaces"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a namespace */ + get: operations["getNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/apis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of contract APIs that have been published */ + get: operations["getContractAPIsNamespace"]; + put?: never; + /** @description Creates and broadcasts a new custom smart contract API */ + post: operations["postNewContractAPINamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/apis/{apiName}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets information about a contract API, including the URLs for the OpenAPI Spec and Swagger UI for the API */ + get: operations["getContractAPIByNameNamespace"]; + /** @description The ID of the contract API */ + put: operations["putContractAPINamespace"]; + post?: never; + /** @description Delete a contract API */ + delete: operations["deleteContractAPINamespace"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/apis/{apiName}/interface": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a contract interface for a contract API */ + get: operations["getContractAPIInterfaceNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/apis/{apiName}/invoke/{methodPath}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Invokes a method on a smart contract API. Performs a blockchain transaction. */ + post: operations["postContractAPIInvokeNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/apis/{apiName}/listeners/{eventPath}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of contract listeners */ + get: operations["getContractAPIListenersNamespace"]; + put?: never; + /** @description Creates a new blockchain listener for events emitted by custom smart contracts */ + post: operations["postContractAPIListenersNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/apis/{apiName}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publish a contract API to all other members of the multiparty network */ + post: operations["postContractAPIPublishNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/apis/{apiName}/query/{methodPath}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Queries a method on a smart contract API. Performs a read-only query. */ + post: operations["postContractAPIQueryNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/batches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of message batches */ + get: operations["getBatchesNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/batches/{batchid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a message batch */ + get: operations["getBatchByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/batches/{batchid}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Cancel a batch that has failed to dispatch */ + post: operations["postBatchCancelNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/blockchainevents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of blockchain events */ + get: operations["getBlockchainEventsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/blockchainevents/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a blockchain event */ + get: operations["getBlockchainEventByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/charts/histogram/{collection}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a JSON object containing statistics data that can be used to build a graphical representation of recent activity in a given database collection */ + get: operations["getChartHistogramNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/deploy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Deploy a new smart contract */ + post: operations["postContractDeployNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/interfaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of contract interfaces that have been published */ + get: operations["getContractInterfacesNamespace"]; + put?: never; + /** @description Creates and broadcasts a new custom smart contract interface */ + post: operations["postNewContractInterfaceNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/interfaces/{interfaceId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a contract interface by its ID */ + get: operations["getContractInterfaceNamespace"]; + put?: never; + post?: never; + /** @description Delete a contract interface */ + delete: operations["deleteContractInterfaceNamespace"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/interfaces/{name}/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a contract interface by its name and version */ + get: operations["getContractInterfaceByNameAndVersionNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/interfaces/{name}/{version}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publish a contract interface to all other members of the multiparty network */ + post: operations["postContractInterfacePublishNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/interfaces/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description A convenience method to convert a blockchain specific smart contract format into a FireFly Interface format. The specific blockchain plugin in use must support this functionality. */ + post: operations["postGenerateContractInterfaceNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/invoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Invokes a method on a smart contract. Performs a blockchain transaction. */ + post: operations["postContractInvokeNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/listeners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of contract listeners */ + get: operations["getContractListenersNamespace"]; + put?: never; + /** @description Creates a new blockchain listener for events emitted by custom smart contracts */ + post: operations["postNewContractListenerNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/listeners/{nameOrId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a contract listener by its name or ID */ + get: operations["getContractListenerByNameOrIDNamespace"]; + put?: never; + post?: never; + /** @description Deletes a contract listener referenced by its name or its ID */ + delete: operations["deleteContractListenerNamespace"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/listeners/signature": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Calculates the hash of a blockchain listener filters and events */ + post: operations["postContractListenerSignatureNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/contracts/query": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Queries a method on a smart contract. Performs a read-only query. */ + post: operations["postContractQueryNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of data items */ + get: operations["getDataNamespace"]; + put?: never; + /** @description Creates a new data item in this FireFly node */ + post: operations["postDataNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/data/{dataid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a data item by its ID, including metadata about this item */ + get: operations["getDataByIDNamespace"]; + put?: never; + post?: never; + /** @description Deletes a data item by its ID, including metadata about this item */ + delete: operations["deleteDataNamespace"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/data/{dataid}/blob": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Downloads the original file that was previously uploaded or received */ + get: operations["getDataBlobNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/data/{dataid}/blob/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publishes the binary blob attachment stored in your local data exchange, to shared storage */ + post: operations["postDataBlobPublishNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/data/{dataid}/messages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of the messages associated with a data item */ + get: operations["getDataMsgsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/data/{dataid}/value": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Downloads the JSON value of the data resource, without the associated metadata */ + get: operations["getDataValueNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/data/{dataid}/value/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publishes the JSON value from the specified data resource, to shared storage */ + post: operations["postDataValuePublishNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/datasubpaths/{parent}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of path names of named blob data, underneath a given parent path ('/' path prefixes are automatically pre-prepended) */ + get: operations["getDataSubPathsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/datatypes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of datatypes that have been published */ + get: operations["getDatatypesNamespace"]; + put?: never; + /** @description Creates and broadcasts a new datatype */ + post: operations["postNewDatatypeNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/datatypes/{name}/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a datatype by its name and version */ + get: operations["getDatatypeByNameNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of events */ + get: operations["getEventsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/events/{eid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets an event by its ID */ + get: operations["getEventByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of groups */ + get: operations["getGroupsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/groups/{hash}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a group by its ID (hash) */ + get: operations["getGroupByHashNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/identities": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of all identities that have been registered in the namespace */ + get: operations["getIdentitiesNamespace"]; + put?: never; + /** @description Registers a new identity in the network */ + post: operations["postNewIdentityNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/identities/{did}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets an identity by its ID */ + get: operations["getIdentityByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** @description Updates an identity */ + patch: operations["patchUpdateIdentityNamespace"]; + trace?: never; + }; + "/namespaces/{ns}/identities/{iid}/did": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the DID for an identity based on its ID */ + get: operations["getIdentityDIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/identities/{iid}/verifiers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the verifiers for an identity */ + get: operations["getIdentityVerifiersNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/messages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of messages */ + get: operations["getMsgsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/messages/{msgid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a message by its ID */ + get: operations["getMsgByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/messages/{msgid}/data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the list of data items that are attached to a message */ + get: operations["getMsgDataNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/messages/{msgid}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the list of events for a message */ + get: operations["getMsgEventsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/messages/{msgid}/transaction": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the transaction for a message */ + get: operations["getMsgTxnNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/messages/broadcast": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Broadcasts a message to all members in the network */ + post: operations["postNewMessageBroadcastNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/messages/private": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Privately sends a message to one or more members in the network */ + post: operations["postNewMessagePrivateNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/messages/requestreply": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Sends a message with a blocking HTTP request, waits for a reply to that message, then sends the reply as the HTTP response. */ + post: operations["postNewMessageRequestReplyNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/action": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Notify all nodes in the network of a new governance action */ + post: operations["postNetworkActionNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/diddocs/{did}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a DID document by its DID */ + get: operations["getNetworkDIDDocByDIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/identities": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * @deprecated + * @description Gets the list of identities in the network (deprecated - use /identities instead of /network/identities + */ + get: operations["getNetworkIdentitiesNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/identities/{did}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * @deprecated + * @description Gets an identity by its DID + */ + get: operations["getNetworkIdentityByDIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/nodes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of nodes in the network */ + get: operations["getNetworkNodesNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/nodes/{nameOrId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets information about a specific node in the network */ + get: operations["getNetworkNodeNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/nodes/self": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Instructs this FireFly node to register itself on the network */ + post: operations["postNodesSelfNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of orgs in the network */ + get: operations["getNetworkOrgsNamespace"]; + put?: never; + /** @description Registers a new org in the network */ + post: operations["postNewOrganizationNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/organizations/{nameOrId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets information about a specific org in the network */ + get: operations["getNetworkOrgNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/network/organizations/self": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Instructs this FireFly node to register its org on the network */ + post: operations["postNewOrganizationSelfNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/nextpins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Queries the list of next-pins that determine the next masked message sequence for each member of a privacy group, on each context/topic */ + get: operations["getNextPinsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/operations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a a list of operations */ + get: operations["getOpsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/operations/{opid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets an operation by ID */ + get: operations["getOpByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/operations/{opid}/retry": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Retries a failed operation */ + post: operations["postOpRetryNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/pins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Queries the list of pins received from the blockchain */ + get: operations["getPinsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/pins/rewind": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Force a rewind of the event aggregator to a previous position, to re-evaluate (and possibly dispatch) that pin and others after it. Only accepts a sequence or batch ID for a currently undispatched pin */ + post: operations["postPinsRewindNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the status of this namespace */ + get: operations["getStatusNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/status/batchmanager": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the status of the batch manager */ + get: operations["getStatusBatchManagerNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/status/multiparty": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the registration status of this organization and node on the configured multiparty network */ + get: operations["getStatusMultipartyNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of subscriptions */ + get: operations["getSubscriptionsNamespace"]; + /** @description Update an existing subscription */ + put: operations["putSubscriptionNamespace"]; + /** @description Creates a new subscription for an application to receive events from FireFly */ + post: operations["postNewSubscriptionNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/subscriptions/{subid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a subscription by its ID */ + get: operations["getSubscriptionByIDNamespace"]; + put?: never; + post?: never; + /** @description Deletes a subscription */ + delete: operations["deleteSubscriptionNamespace"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/subscriptions/{subid}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a collection of events filtered by the subscription for further filtering */ + get: operations["getSubscriptionEventsFilteredNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token accounts */ + get: operations["getTokenAccountsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/accounts/{key}/pools": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token pools that contain a given token account key */ + get: operations["getTokenAccountPoolsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token approvals */ + get: operations["getTokenApprovalsNamespace"]; + put?: never; + /** @description Creates a token approval */ + post: operations["postTokenApprovalNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/balances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token balances */ + get: operations["getTokenBalancesNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/burn": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Burns some tokens */ + post: operations["postTokenBurnNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/connectors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the list of token connectors currently in use */ + get: operations["getTokenConnectorsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/mint": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Mints some tokens */ + post: operations["postTokenMintNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/pools": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token pools */ + get: operations["getTokenPoolsNamespace"]; + put?: never; + /** @description Creates a new token pool */ + post: operations["postTokenPoolNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/pools/{nameOrId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a token pool by its name or its ID */ + get: operations["getTokenPoolByNameOrIDNamespace"]; + put?: never; + post?: never; + /** @description Delete a token pool */ + delete: operations["deleteTokenPoolNamespace"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/pools/{nameOrId}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publish a token pool to all other members of the multiparty network */ + post: operations["postTokenPoolPublishNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token transfers */ + get: operations["getTokenTransfersNamespace"]; + put?: never; + /** @description Transfers some tokens */ + post: operations["postTokenTransferNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/tokens/transfers/{transferId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a token transfer by its ID */ + get: operations["getTokenTransferByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/transactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of transactions */ + get: operations["getTxnsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/transactions/{txnid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a transaction by its ID */ + get: operations["getTxnByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/transactions/{txnid}/blockchainevents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list blockchain events for a specific transaction */ + get: operations["getTxnBlockchainEventsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/transactions/{txnid}/operations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of operations in a specific transaction */ + get: operations["getTxnOpsNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/transactions/{txnid}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the status of a transaction */ + get: operations["getTxnStatusNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/verifiers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of verifiers */ + get: operations["getVerifiersNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/verifiers/{hash}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a verifier by its hash */ + get: operations["getVerifierByIDNamespace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/namespaces/{ns}/verifiers/resolve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Resolves an input key to a signing key */ + post: operations["postVerifiersResolveNamespace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/action": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Notify all nodes in the network of a new governance action */ + post: operations["postNetworkAction"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/diddocs/{did}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a DID document by its DID */ + get: operations["getNetworkDIDDocByDID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/identities": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * @deprecated + * @description Gets the list of identities in the network (deprecated - use /identities instead of /network/identities + */ + get: operations["getNetworkIdentities"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/identities/{did}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * @deprecated + * @description Gets an identity by its DID + */ + get: operations["getNetworkIdentityByDID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/nodes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of nodes in the network */ + get: operations["getNetworkNodes"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/nodes/{nameOrId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets information about a specific node in the network */ + get: operations["getNetworkNode"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/nodes/self": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Instructs this FireFly node to register itself on the network */ + post: operations["postNodesSelf"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of orgs in the network */ + get: operations["getNetworkOrgs"]; + put?: never; + /** @description Registers a new org in the network */ + post: operations["postNewOrganization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/organizations/{nameOrId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets information about a specific org in the network */ + get: operations["getNetworkOrg"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/network/organizations/self": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Instructs this FireFly node to register its org on the network */ + post: operations["postNewOrganizationSelf"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/nextpins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Queries the list of next-pins that determine the next masked message sequence for each member of a privacy group, on each context/topic */ + get: operations["getNextPins"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/operations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a a list of operations */ + get: operations["getOps"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/operations/{opid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets an operation by ID */ + get: operations["getOpByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/operations/{opid}/retry": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Retries a failed operation */ + post: operations["postOpRetry"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/pins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Queries the list of pins received from the blockchain */ + get: operations["getPins"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/pins/rewind": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Force a rewind of the event aggregator to a previous position, to re-evaluate (and possibly dispatch) that pin and others after it. Only accepts a sequence or batch ID for a currently undispatched pin */ + post: operations["postPinsRewind"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the status of this namespace */ + get: operations["getStatus"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/status/batchmanager": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the status of the batch manager */ + get: operations["getStatusBatchManager"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/status/multiparty": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the registration status of this organization and node on the configured multiparty network */ + get: operations["getStatusMultiparty"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of subscriptions */ + get: operations["getSubscriptions"]; + /** @description Update an existing subscription */ + put: operations["putSubscription"]; + /** @description Creates a new subscription for an application to receive events from FireFly */ + post: operations["postNewSubscription"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/subscriptions/{subid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a subscription by its ID */ + get: operations["getSubscriptionByID"]; + put?: never; + post?: never; + /** @description Deletes a subscription */ + delete: operations["deleteSubscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/subscriptions/{subid}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a collection of events filtered by the subscription for further filtering */ + get: operations["getSubscriptionEventsFiltered"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token accounts */ + get: operations["getTokenAccounts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/accounts/{key}/pools": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token pools that contain a given token account key */ + get: operations["getTokenAccountPools"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token approvals */ + get: operations["getTokenApprovals"]; + put?: never; + /** @description Creates a token approval */ + post: operations["postTokenApproval"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/balances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token balances */ + get: operations["getTokenBalances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/burn": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Burns some tokens */ + post: operations["postTokenBurn"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/connectors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the list of token connectors currently in use */ + get: operations["getTokenConnectors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/mint": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Mints some tokens */ + post: operations["postTokenMint"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/pools": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token pools */ + get: operations["getTokenPools"]; + put?: never; + /** @description Creates a new token pool */ + post: operations["postTokenPool"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/pools/{nameOrId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a token pool by its name or its ID */ + get: operations["getTokenPoolByNameOrID"]; + put?: never; + post?: never; + /** @description Delete a token pool */ + delete: operations["deleteTokenPool"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/pools/{nameOrId}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Publish a token pool to all other members of the multiparty network */ + post: operations["postTokenPoolPublish"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of token transfers */ + get: operations["getTokenTransfers"]; + put?: never; + /** @description Transfers some tokens */ + post: operations["postTokenTransfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tokens/transfers/{transferId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a token transfer by its ID */ + get: operations["getTokenTransferByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of transactions */ + get: operations["getTxns"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{txnid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a transaction by its ID */ + get: operations["getTxnByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{txnid}/blockchainevents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list blockchain events for a specific transaction */ + get: operations["getTxnBlockchainEvents"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{txnid}/operations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of operations in a specific transaction */ + get: operations["getTxnOps"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{txnid}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets the status of a transaction */ + get: operations["getTxnStatus"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/verifiers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of verifiers */ + get: operations["getVerifiers"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/verifiers/{hash}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a verifier by its hash */ + get: operations["getVerifierByID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/verifiers/resolve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Resolves an input key to a signing key */ + post: operations["postVerifiersResolve"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/websockets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Gets a list of the current WebSocket connections to this node */ + get: operations["getWebSockets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: never; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; } - -export interface components {} - +export type $defs = Record; export interface operations { - /** Gets a list of contract APIs that have been published */ - getContractAPIs: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interface?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - networkname?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - published?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates and broadcasts a new custom smart contract API */ - postNewContractAPI: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - /** When true the definition will be published to all other members of the multiparty network */ - publish?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - }; - }; - }; - }; - /** Gets information about a contract API, including the URLs for the OpenAPI Spec and Swagger UI for the API */ - getContractAPIByName: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - default: unknown; - }; - }; - /** Delete a contract API */ - deleteContractAPI: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Gets a contract interface for a contract API */ - getContractAPIInterface: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Invokes a method on a smart contract API. Performs a blockchain transaction. */ - postContractAPIInvoke: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The name or uniquely generated path name of a method on a smart contract */ - methodPath: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { [key: string]: any }; - /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ + getContractAPIs: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interface?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + networkname?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + published?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; }; - /** @description The message header contains all fields that are used to build the message hash */ header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets a list of contract listeners */ - getContractAPIListeners: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The name or uniquely generated path name of a event on a smart contract */ - eventPath: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - backendid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interface?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - location?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - signature?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topic?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a new blockchain listener for events emitted by custom smart contracts */ - postContractAPIListeners: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The name or uniquely generated path name of a event on a smart contract */ - eventPath: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - }; - /** Publish a contract API to all other members of the multiparty network */ - postContractAPIPublish: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ - networkName?: string; - }; - }; - }; - }; - /** Queries a method on a smart contract API. Performs a read-only query. */ - postContractAPIQuery: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The name or uniquely generated path name of a method on a smart contract */ - methodPath: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { [key: string]: any }; - /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** The ID of the contract API */ - putContractAPI: { - parameters: { - path: { - /** The name of the contract API */ - id: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - }; - }; - }; - }; - /** Gets a list of message batches */ - getBatches: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - node?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - payloadref?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: date-time - * @description The time when the batch was confirmed - */ - confirmed?: string; - /** - * Format: date-time - * @description The time the batch was sealed - */ - created?: string; - /** - * Format: byte - * @description The privacy group the batch is sent to, for private batches - */ - group?: string; - /** - * Format: byte - * @description The hash of the manifest of the batch - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the batch - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The manifest of the batch */ - manifest?: any; - /** @description The namespace of the batch */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the node that generated the batch - */ - node?: string; - /** @description The FireFly transaction associated with this batch */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of the batch - * @enum {string} - */ - type?: "broadcast" | "private"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a message batch */ - getBatchByID: { - parameters: { - path: { - /** The batch ID */ - batchid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: date-time - * @description The time when the batch was confirmed - */ - confirmed?: string; - /** - * Format: date-time - * @description The time the batch was sealed - */ - created?: string; - /** - * Format: byte - * @description The privacy group the batch is sent to, for private batches - */ - group?: string; - /** - * Format: byte - * @description The hash of the manifest of the batch - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the batch - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The manifest of the batch */ - manifest?: any; - /** @description The namespace of the batch */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the node that generated the batch - */ - node?: string; - /** @description The FireFly transaction associated with this batch */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of the batch - * @enum {string} - */ - type?: "broadcast" | "private"; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of blockchain events */ - getBlockchainEvents: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - listener?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - protocolid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - source?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - timestamp?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.blockchainid"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID assigned to the event by FireFly - */ - id?: string; - /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace - */ - listener?: string; - /** @description The name of the event in the blockchain smart contract */ - name?: string; - /** @description The namespace of the listener that detected this blockchain event */ - namespace?: string; - /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { [key: string]: any }; - /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ - protocolId?: string; - /** @description The blockchain plugin or token service that detected the event */ - source?: string; - /** - * Format: date-time - * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors - */ - timestamp?: string; - /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ - tx?: { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ - blockchainId?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a blockchain event */ - getBlockchainEventByID: { - parameters: { - path: { - /** The blockchain event ID */ - id: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID assigned to the event by FireFly - */ - id?: string; - /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace - */ - listener?: string; - /** @description The name of the event in the blockchain smart contract */ - name?: string; - /** @description The namespace of the listener that detected this blockchain event */ - namespace?: string; - /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { [key: string]: any }; - /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ - protocolId?: string; - /** @description The blockchain plugin or token service that detected the event */ - source?: string; - /** - * Format: date-time - * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors - */ - timestamp?: string; - /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ - tx?: { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ - blockchainId?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a JSON object containing statistics data that can be used to build a graphical representation of recent activity in a given database collection */ - getChartHistogram: { - parameters: { - path: { - /** The collection ID */ - collection: string; - }; - query: { - /** Start time of the data to be fetched */ - startTime?: string; - /** End time of the data to be fetched */ - endTime?: string; - /** Number of buckets between start time and end time */ - buckets?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Total count of entries in this time bucket within the histogram */ - count?: string; - /** @description Indicates whether there are more results in this bucket that are not being displayed */ - isCapped?: boolean; - /** - * Format: date-time - * @description Starting timestamp for the bucket - */ - timestamp?: string; - /** @description Array of separate counts for individual types of record within the bucket */ - types?: { - /** @description Count of entries of a given type within a bucket */ - count?: string; - /** @description Name of the type */ - type?: string; - }[]; - }[]; - }; - }; - default: unknown; - }; - }; - /** Deploy a new smart contract */ - postContractDeploy: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The smart contract to deploy. This should be pre-compiled if required by the blockchain connector */ - contract?: any; - /** @description The definition of the smart contract */ - definition?: any; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description An optional array of inputs passed to the smart contract's constructor, if applicable */ - input?: any[]; - /** @description The blockchain signing key that will be used to deploy the contract. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets a list of contract interfaces that have been published */ - getContractInterfaces: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - networkname?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - published?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - version?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates and broadcasts a new custom smart contract interface */ - postNewContractInterface: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - /** When true the definition will be published to all other members of the multiparty network */ - publish?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** @description The name of the error */ - name?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the method */ - name?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - }; - /** Gets a contract interface by its ID */ - getContractInterface: { - parameters: { - path: { - /** The ID of the contract interface */ - interfaceId: string; - }; - query: { - /** When set, the API will return the full FireFly Interface document including all methods, events, and parameters */ - fetchchildren?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Delete a contract interface */ - deleteContractInterface: { - parameters: { - path: { - /** The ID of the contract interface */ - interfaceId: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Gets a contract interface by its name and version */ - getContractInterfaceByNameAndVersion: { - parameters: { - path: { - /** The name of the contract interface */ - name: string; - /** The version of the contract interface */ - version: string; - }; - query: { - /** When set, the API will return the full FireFly Interface document including all methods, events, and parameters */ - fetchchildren?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Publish a contract interface to all other members of the multiparty network */ - postContractInterfacePublish: { - parameters: { - path: { - /** The name of the contract interface */ - name: string; - /** The version of the contract interface */ - version: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ - networkName?: string; - }; - }; - }; - }; - /** A convenience method to convert a blockchain specific smart contract format into a FireFly Interface format. The specific blockchain plugin in use must support this functionality. */ - postGenerateContractInterface: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The description of the FFI to be generated. Defaults to the description extracted by the blockchain specific converter utility */ - description?: string; - /** @description A blockchain connector specific payload. For example in Ethereum this is a JSON structure containing an 'abi' array, and optionally a 'devdocs' array. */ - input?: any; - /** @description The name of the FFI to generate */ - name?: string; - /** @description The namespace into which the FFI will be generated */ - namespace?: string; - /** @description The version of the FFI to generate */ - version?: string; - }; - }; - }; - }; - /** Invokes a method on a smart contract. Performs a blockchain transaction. */ - postContractInvoke: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** @description The name of the error */ - name?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface - */ - interface?: string; - /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewContractAPI: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + /** @description When true the definition will be published to all other members of the multiparty network */ + publish?: string; }; - /** @description The message header contains all fields that are used to build the message hash */ header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ - method?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the method */ - name?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description The pathname of the method on the specified FFI */ - methodPath?: string; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets a list of contract listeners */ - getContractListeners: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - backendid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interface?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - location?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - signature?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topic?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a new blockchain listener for events emitted by custom smart contracts */ - postNewContractListener: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ - eventPath?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - }; - /** Gets a contract listener by its name or ID */ - getContractListenerByNameOrID: { - parameters: { - path: { - /** The contract listener name or ID */ - nameOrId: string; - }; - query: { - /** When set, the API will return additional status information if available */ - fetchstatus?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Deletes a contract listener referenced by its name or its ID */ - deleteContractListener: { - parameters: { - path: { - /** The contract listener name or ID */ - nameOrId: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Queries a method on a smart contract. Performs a read-only query. */ - postContractQuery: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** @description The name of the error */ - name?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface - */ - interface?: string; - /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ - method?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the method */ - name?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description The pathname of the method on the specified FFI */ - methodPath?: string; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets a list of data items */ - getData: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.hash"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.name"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.path"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.public"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.size"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "datatype.name"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "datatype.version"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - public?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - validator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - value?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a new data item in this FireFly node */ - postData: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 201: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }; - "multipart/form-data": { - /** @description Success */ - autometa?: string; - /** @description Success */ - "datatype.name"?: string; - /** @description Success */ - "datatype.version"?: string; - /** Format: binary */ - "filename.ext"?: string; - /** @description Success */ - metadata?: string; - /** @description Success */ - validator?: string; - }; - }; - }; - }; - /** Gets a data item by its ID, including metadata about this item */ - getDataByID: { - parameters: { - path: { - /** The data item ID */ - dataid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }; - }; - }; - default: unknown; - }; - }; - /** Deletes a data item by its ID, including metadata about this item */ - deleteData: { - parameters: { - path: { - /** The data item ID */ - dataid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Downloads the original file that was previously uploaded or received */ - getDataBlob: { - parameters: { - path: { - /** The data item ID */ - dataid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - cid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - datahash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pins?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - rejectreason?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tag?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topics?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txtype?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": string; - }; - }; - default: unknown; - }; - }; - /** Publishes the binary blob attachment stored in your local data exchange, to shared storage */ - postDataBlobPublish: { - parameters: { - path: { - /** The blob ID */ - dataid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Gets a list of the messages associated with a data item */ - getDataMsgs: { - parameters: { - path: { - /** The data item ID */ - dataid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - cid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - datahash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pins?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - rejectreason?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tag?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topics?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txtype?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractAPIByName: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Downloads the JSON value of the data resource, without the associated metadata */ - getDataValue: { - parameters: { - path: { - /** The blob ID */ - dataid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - cid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - datahash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pins?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - rejectreason?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tag?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topics?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txtype?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": string; - }; - }; - default: unknown; - }; - }; - /** Publishes the JSON value from the specified data resource, to shared storage */ - postDataValuePublish: { - parameters: { - path: { - /** The blob ID */ - dataid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Gets a list of path names of named blob data, underneath a given parent path ('/' path prefixes are automatically pre-prepended) */ - getDataSubPaths: { - parameters: { - path: { - /** The parent path to query */ - parent: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": string[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of datatypes that have been published */ - getDatatypes: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - validator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - version?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the datatype was created - */ - created?: string; - /** - * Format: byte - * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the datatype - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this datatype to the network - */ - message?: string; - /** @description The name of the datatype */ - name?: string; - /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ - namespace?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates and broadcasts a new datatype */ - postNewDatatype: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the datatype was created - */ - created?: string; - /** - * Format: byte - * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the datatype - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this datatype to the network - */ - message?: string; - /** @description The name of the datatype */ - name?: string; - /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ - namespace?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the datatype was created - */ - created?: string; - /** - * Format: byte - * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the datatype - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this datatype to the network - */ - message?: string; - /** @description The name of the datatype */ - name?: string; - /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ - namespace?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the datatype */ - name?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }; - }; - }; - }; - /** Gets a datatype by its name and version */ - getDatatypeByName: { - parameters: { - path: { - /** The name of the datatype */ - name: string; - /** The version of the datatype */ - version: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the datatype was created - */ - created?: string; - /** - * Format: byte - * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the datatype - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this datatype to the network - */ - message?: string; - /** @description The name of the datatype */ - name?: string; - /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ - namespace?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of events */ - getEvents: { - parameters: { - query: { - /** When set, the API will return the record that this item references in its 'reference' field */ - fetchreferences?: string; - /** When set, the API will return the record that this item references in its 'reference' field */ - fetchreference?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - correlator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - reference?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topic?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tx?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool - */ - correlator?: string; - /** - * Format: date-time - * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications - */ - created?: string; - /** - * Format: uuid - * @description The UUID assigned to this event by your local FireFly node - */ - id?: string; - /** @description The namespace of the event. Your application must subscribe to events within a namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset - */ - reference?: string; - /** - * Format: int64 - * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) - */ - sequence?: number; - /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ - topic?: string; - /** - * Format: uuid - * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction - */ - tx?: string; - /** - * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application - * @enum {string} - */ - type?: - | "transaction_submitted" - | "message_confirmed" - | "message_rejected" - | "datatype_confirmed" - | "identity_confirmed" - | "identity_updated" - | "token_pool_confirmed" - | "token_pool_op_failed" - | "token_transfer_confirmed" - | "token_transfer_op_failed" - | "token_approval_confirmed" - | "token_approval_op_failed" - | "contract_interface_confirmed" - | "contract_api_confirmed" - | "blockchain_event_received" - | "blockchain_invoke_op_succeeded" - | "blockchain_invoke_op_failed" - | "blockchain_contract_deploy_op_succeeded" - | "blockchain_contract_deploy_op_failed"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets an event by its ID */ - getEventByID: { - parameters: { - path: { - /** The event ID */ - eid: string; - }; - query: { - /** When set, the API will return the record that this item references in its 'reference' field */ - fetchreference?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool - */ - correlator?: string; - /** - * Format: date-time - * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications - */ - created?: string; - /** - * Format: uuid - * @description The UUID assigned to this event by your local FireFly node - */ - id?: string; - /** @description The namespace of the event. Your application must subscribe to events within a namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset - */ - reference?: string; - /** - * Format: int64 - * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) - */ - sequence?: number; - /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ - topic?: string; - /** - * Format: uuid - * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction - */ - tx?: string; - /** - * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application - * @enum {string} - */ - type?: - | "transaction_submitted" - | "message_confirmed" - | "message_rejected" - | "datatype_confirmed" - | "identity_confirmed" - | "identity_updated" - | "token_pool_confirmed" - | "token_pool_op_failed" - | "token_transfer_confirmed" - | "token_transfer_op_failed" - | "token_approval_confirmed" - | "token_approval_op_failed" - | "contract_interface_confirmed" - | "contract_api_confirmed" - | "blockchain_event_received" - | "blockchain_invoke_op_succeeded" - | "blockchain_invoke_op_failed" - | "blockchain_contract_deploy_op_succeeded" - | "blockchain_contract_deploy_op_failed"; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of groups */ - getGroups: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - ledger?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time when the group was first used to send a message in the network - */ - created?: string; - /** - * Format: byte - * @description The identifier hash of this group. Derived from the name and group members - */ - hash?: string; - /** @description The local namespace of the group */ - localNamespace?: string; - /** @description The list of members in this privacy group */ - members?: { - /** @description The DID of the group member */ - identity?: string; - /** - * Format: uuid - * @description The UUID of the node that receives a copy of the off-chain message for the identity - */ - node?: string; - }[]; - /** - * Format: uuid - * @description The message used to broadcast this group privately to the members - */ - message?: string; - /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ - name?: string; - /** @description The namespace of the group within the multiparty network */ - namespace?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a group by its ID (hash) */ - getGroupByHash: { - parameters: { - path: { - /** The hash of the group */ - hash: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time when the group was first used to send a message in the network - */ - created?: string; - /** - * Format: byte - * @description The identifier hash of this group. Derived from the name and group members - */ - hash?: string; - /** @description The local namespace of the group */ - localNamespace?: string; - /** @description The list of members in this privacy group */ - members?: { - /** @description The DID of the group member */ - identity?: string; - /** - * Format: uuid - * @description The UUID of the node that receives a copy of the off-chain message for the identity - */ - node?: string; - }[]; - /** - * Format: uuid - * @description The message used to broadcast this group privately to the members - */ - message?: string; - /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ - name?: string; - /** @description The namespace of the group within the multiparty network */ - namespace?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of all identities that have been registered in the namespace */ - getIdentities: { - parameters: { - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - did?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.claim"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.update"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.verification"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - parent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - profile?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }[]; - }; - }; - default: unknown; - }; - }; - /** Registers a new identity in the network */ - postNewIdentity: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The blockchain signing key to use to make the claim to the identity. Must be available to the local node to sign the identity claim. Will become a verifier on the established identity */ - key?: string; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** @description The type of the identity */ - type?: string; - }; - }; - }; - }; - /** Gets an identity by its DID */ - getIdentityByDID: { - parameters: { - path: { - /** The identity DID */ - did: string; - }; - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets an identity by its ID */ - getIdentityByID: { - parameters: { - path: { - /** The identity ID, which is a UUID generated by FireFly */ - iid: string; - }; - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Updates an identity */ - patchUpdateIdentity: { - parameters: { - path: { - /** The identity ID, which is a UUID generated by FireFly */ - iid: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets the DID for an identity based on its ID */ - getIdentityDID: { - parameters: { - path: { - /** The identity ID, which is a UUID generated by FireFly */ - iid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description See https://www.w3.org/TR/did-core/#json-ld */ - "@context"?: string[]; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - authentication?: string[]; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - id?: string; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - verificationMethod?: { - /** @description For blockchains like Ethereum that represent signing identities directly by their public key summarized in an account string */ - blockchainAcountId?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - controller?: string; - /** @description A string provided by your Data Exchange plugin, that it uses a technology specific mechanism to validate against when messages arrive from this identity */ - dataExchangePeerID?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - id?: string; - /** @description For Hyperledger Fabric where the signing identity is represented by an MSP identifier (containing X509 certificate DN strings) that were validated by your local MSP */ - mspIdentityString?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - type?: string; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets the verifiers for an identity */ - getIdentityVerifiers: { - parameters: { - path: { - /** The identity ID, which is a UUID generated by FireFly */ - iid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - identity?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - value?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time this verifier was created on this node - */ - created?: string; - /** - * Format: byte - * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the parent identity that has claimed this verifier - */ - identity?: string; - /** @description The namespace of the verifier */ - namespace?: string; - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of messages */ - getMsgs: { - parameters: { - query: { - /** Fetch the data and include it in the messages returned */ - fetchdata?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - cid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - datahash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pins?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - rejectreason?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tag?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topics?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txtype?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + putContractAPI: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a message by its ID */ - getMsgByID: { - parameters: { - path: { - /** The message ID */ - msgid: string; - }; - query: { - /** Fetch the data and include it in the messages returned */ - fetchdata?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description An optional in-line hash reference to a previously uploaded binary data blob */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteContractAPI: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets the list of data items that are attached to a message */ - getMsgData: { - parameters: { - path: { - /** The message ID */ - msgid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets the list of events for a message */ - getMsgEvents: { - parameters: { - path: { - /** The message ID */ - msgid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - correlator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - reference?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topic?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tx?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool - */ - correlator?: string; - /** - * Format: date-time - * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications - */ - created?: string; - /** - * Format: uuid - * @description The UUID assigned to this event by your local FireFly node - */ - id?: string; - /** @description The namespace of the event. Your application must subscribe to events within a namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset - */ - reference?: string; - /** - * Format: int64 - * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) - */ - sequence?: number; - /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ - topic?: string; - /** - * Format: uuid - * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction - */ - tx?: string; - /** - * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application - * @enum {string} - */ - type?: - | "transaction_submitted" - | "message_confirmed" - | "message_rejected" - | "datatype_confirmed" - | "identity_confirmed" - | "identity_updated" - | "token_pool_confirmed" - | "token_pool_op_failed" - | "token_transfer_confirmed" - | "token_transfer_op_failed" - | "token_approval_confirmed" - | "token_approval_op_failed" - | "contract_interface_confirmed" - | "contract_api_confirmed" - | "blockchain_event_received" - | "blockchain_invoke_op_succeeded" - | "blockchain_invoke_op_failed" - | "blockchain_contract_deploy_op_succeeded" - | "blockchain_contract_deploy_op_failed"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets the transaction for a message */ - getMsgTxn: { - parameters: { - path: { - /** The message ID */ - msgid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ - blockchainIds?: string[]; - /** - * Format: date-time - * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction - */ - created?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ - idempotencyKey?: string; - /** @description The namespace of the FireFly transaction */ - namespace?: string; - /** - * @description The type of the FireFly transaction - * @enum {string} - */ - type?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - }; - }; - }; - default: unknown; - }; - }; - /** Broadcasts a message to all members in the network */ - postNewMessageBroadcast: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractAPIInterface: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractAPIInvoke: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The name or uniquely generated path name of a method on a smart contract */ + methodPath: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ + input?: { + [key: string]: unknown; + }; + /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractAPIListeners: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + backendid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + filters?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Privately sends a message to one or more members in the network */ - postNewMessagePrivate: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interface?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + location?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + signature?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The name or uniquely generated path name of a event on a smart contract */ + eventPath: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractAPIListeners: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Sends a message with a blocking HTTP request, waits for a reply to that message, then sends the reply as the HTTP response. */ - postNewMessageRequestReply: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description An optional in-line hash reference to a previously uploaded binary data blob */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The name or uniquely generated path name of a event on a smart contract */ + eventPath: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractAPIPublish: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractAPIQuery: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The name or uniquely generated path name of a method on a smart contract */ + methodPath: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ + input?: { + [key: string]: unknown; + }; + /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getBatches: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Gets a list of namespaces */ - getNamespaces: { - parameters: { - query: { - /** When set, the API will return namespaces even if they are not yet initialized, including in error cases where an initializationError is included */ - includeinitializing?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the namespace was created - */ - created?: string; - /** @description A description of the namespace */ - description?: string; - /** @description Set to a non-empty string in the case that the namespace is currently failing to initialize */ - initializationError?: string; - /** @description Set to true if the namespace is still initializing */ - initializing?: boolean; - /** @description The local namespace name */ - name?: string; - /** @description The shared namespace name within the multiparty network */ - networkName?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a namespace */ - getNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the namespace was created - */ - created?: string; - /** @description A description of the namespace */ - description?: string; - /** @description The local namespace name */ - name?: string; - /** @description The shared namespace name within the multiparty network */ - networkName?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of contract APIs that have been published */ - getContractAPIsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interface?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - networkname?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - published?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates and broadcasts a new custom smart contract API */ - postNewContractAPINamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - /** When true the definition will be published to all other members of the multiparty network */ - publish?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - }; - }; - }; - }; - /** Gets information about a contract API, including the URLs for the OpenAPI Spec and Swagger UI for the API */ - getContractAPIByNameNamespace: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - default: unknown; - }; - }; - /** Delete a contract API */ - deleteContractAPINamespace: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Gets a contract interface for a contract API */ - getContractAPIInterfaceNamespace: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Invokes a method on a smart contract API. Performs a blockchain transaction. */ - postContractAPIInvokeNamespace: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The name or uniquely generated path name of a method on a smart contract */ - methodPath: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** @description The name of the error */ - name?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface - */ - interface?: string; - /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + payloadref?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; }; - /** @description The message header contains all fields that are used to build the message hash */ header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ - method?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the method */ - name?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description The pathname of the method on the specified FFI */ - methodPath?: string; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets a list of contract listeners */ - getContractAPIListenersNamespace: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The name or uniquely generated path name of a event on a smart contract */ - eventPath: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - backendid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interface?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - location?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - signature?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topic?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a new blockchain listener for events emitted by custom smart contracts */ - postContractAPIListenersNamespace: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The name or uniquely generated path name of a event on a smart contract */ - eventPath: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - }; - /** Publish a contract API to all other members of the multiparty network */ - postContractAPIPublishNamespace: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ - networkName?: string; - }; - }; - }; - }; - /** Queries a method on a smart contract API. Performs a read-only query. */ - postContractAPIQueryNamespace: { - parameters: { - path: { - /** The name of the contract API */ - apiName: string; - /** The name or uniquely generated path name of a method on a smart contract */ - methodPath: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** @description The name of the error */ - name?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface - */ - interface?: string; - /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: date-time + * @description The time when the batch was confirmed + */ + confirmed?: string; + /** + * Format: date-time + * @description The time the batch was sealed + */ + created?: string; + /** + * Format: byte + * @description The privacy group the batch is sent to, for private batches + */ + group?: string; + /** + * Format: byte + * @description The hash of the manifest of the batch + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the batch + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The manifest of the batch */ + manifest?: unknown; + /** @description The namespace of the batch */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the node that generated the batch + */ + node?: string; + /** @description The FireFly transaction associated with this batch */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of the batch + * @enum {string} + */ + type?: "broadcast" | "private"; + }[]; + }; }; - /** @description The message header contains all fields that are used to build the message hash */ + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getBatchByID: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ - method?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the method */ - name?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description The pathname of the method on the specified FFI */ - methodPath?: string; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** The ID of the contract API */ - putContractAPINamespace: { - parameters: { - path: { - /** The name of the contract API */ - id: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the contract API - */ - id?: string; - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this API to the network - */ - message?: string; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The namespace of the contract API */ - namespace?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - /** @description Indicates if the API is published to other members of the multiparty network */ - published?: boolean; - /** @description The URLs to use to access the API */ - urls?: { - /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ - openapi?: string; - /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ - ui?: string; - }; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Reference to the FireFly Interface definition associated with the contract API */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description The name that is used in the URL to access the API */ - name?: string; - /** @description The published name of the API within the multiparty network */ - networkName?: string; - }; - }; - }; - }; - /** Gets a list of message batches */ - getBatchesNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - node?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - payloadref?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: date-time - * @description The time when the batch was confirmed - */ - confirmed?: string; - /** - * Format: date-time - * @description The time the batch was sealed - */ - created?: string; - /** - * Format: byte - * @description The privacy group the batch is sent to, for private batches - */ - group?: string; - /** - * Format: byte - * @description The hash of the manifest of the batch - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the batch - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The manifest of the batch */ - manifest?: any; - /** @description The namespace of the batch */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the node that generated the batch - */ - node?: string; - /** @description The FireFly transaction associated with this batch */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of the batch - * @enum {string} - */ - type?: "broadcast" | "private"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a message batch */ - getBatchByIDNamespace: { - parameters: { - path: { - /** The batch ID */ - batchid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: date-time - * @description The time when the batch was confirmed - */ - confirmed?: string; - /** - * Format: date-time - * @description The time the batch was sealed - */ - created?: string; - /** - * Format: byte - * @description The privacy group the batch is sent to, for private batches - */ - group?: string; - /** - * Format: byte - * @description The hash of the manifest of the batch - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the batch - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The manifest of the batch */ - manifest?: any; - /** @description The namespace of the batch */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the node that generated the batch - */ - node?: string; - /** @description The FireFly transaction associated with this batch */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of the batch - * @enum {string} - */ - type?: "broadcast" | "private"; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of blockchain events */ - getBlockchainEventsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - listener?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - protocolid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - source?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - timestamp?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.blockchainid"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID assigned to the event by FireFly - */ - id?: string; - /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace - */ - listener?: string; - /** @description The name of the event in the blockchain smart contract */ - name?: string; - /** @description The namespace of the listener that detected this blockchain event */ - namespace?: string; - /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { [key: string]: any }; - /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ - protocolId?: string; - /** @description The blockchain plugin or token service that detected the event */ - source?: string; - /** - * Format: date-time - * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors - */ - timestamp?: string; - /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ - tx?: { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ - blockchainId?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a blockchain event */ - getBlockchainEventByIDNamespace: { - parameters: { - path: { - /** The blockchain event ID */ - id: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID assigned to the event by FireFly - */ - id?: string; - /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace - */ - listener?: string; - /** @description The name of the event in the blockchain smart contract */ - name?: string; - /** @description The namespace of the listener that detected this blockchain event */ - namespace?: string; - /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { [key: string]: any }; - /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ - protocolId?: string; - /** @description The blockchain plugin or token service that detected the event */ - source?: string; - /** - * Format: date-time - * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors - */ - timestamp?: string; - /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ - tx?: { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ - blockchainId?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a JSON object containing statistics data that can be used to build a graphical representation of recent activity in a given database collection */ - getChartHistogramNamespace: { - parameters: { - path: { - /** The collection ID */ - collection: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** Start time of the data to be fetched */ - startTime?: string; - /** End time of the data to be fetched */ - endTime?: string; - /** Number of buckets between start time and end time */ - buckets?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Total count of entries in this time bucket within the histogram */ - count?: string; - /** @description Indicates whether there are more results in this bucket that are not being displayed */ - isCapped?: boolean; - /** - * Format: date-time - * @description Starting timestamp for the bucket - */ - timestamp?: string; - /** @description Array of separate counts for individual types of record within the bucket */ - types?: { - /** @description Count of entries of a given type within a bucket */ - count?: string; - /** @description Name of the type */ - type?: string; - }[]; - }[]; - }; - }; - default: unknown; - }; - }; - /** Deploy a new smart contract */ - postContractDeployNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The smart contract to deploy. This should be pre-compiled if required by the blockchain connector */ - contract?: any; - /** @description The definition of the smart contract */ - definition?: any; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description An optional array of inputs passed to the smart contract's constructor, if applicable */ - input?: any[]; - /** @description The blockchain signing key that will be used to deploy the contract. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets a list of contract interfaces that have been published */ - getContractInterfacesNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - networkname?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - published?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - version?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates and broadcasts a new custom smart contract interface */ - postNewContractInterfaceNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - /** When true the definition will be published to all other members of the multiparty network */ - publish?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** @description The name of the error */ - name?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the method */ - name?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - }; - /** Gets a contract interface by its ID */ - getContractInterfaceNamespace: { - parameters: { - path: { - /** The ID of the contract interface */ - interfaceId: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the full FireFly Interface document including all methods, events, and parameters */ - fetchchildren?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Delete a contract interface */ - deleteContractInterfaceNamespace: { - parameters: { - path: { - /** The ID of the contract interface */ - interfaceId: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Gets a contract interface by its name and version */ - getContractInterfaceByNameAndVersionNamespace: { - parameters: { - path: { - /** The name of the contract interface */ - name: string; - /** The version of the contract interface */ - version: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the full FireFly Interface document including all methods, events, and parameters */ - fetchchildren?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Publish a contract interface to all other members of the multiparty network */ - postContractInterfacePublishNamespace: { - parameters: { - path: { - /** The name of the contract interface */ - name: string; - /** The version of the contract interface */ - version: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ - networkName?: string; - }; - }; - }; - }; - /** A convenience method to convert a blockchain specific smart contract format into a FireFly Interface format. The specific blockchain plugin in use must support this functionality. */ - postGenerateContractInterfaceNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A description of the smart contract this FFI represents */ - description?: string; - /** @description An array of smart contract error definitions */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** - * Format: uuid - * @description The UUID of the FFI error definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this error is part of - */ - interface?: string; - /** @description The name of the error */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this error within the FFI for use on URL paths */ - pathname?: string; - /** @description The stringified signature of the error, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** @description An array of smart contract event definitions */ - events?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI event definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this event is part of - */ - interface?: string; - /** @description The name of the event */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ - pathname?: string; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - }[]; - /** - * Format: uuid - * @description The UUID of the FireFly interface (FFI) smart contract definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this FFI to the network - */ - message?: string; - /** @description An array of smart contract method definitions */ - methods?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the FFI method definition - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the FFI smart contract definition that this method is part of - */ - interface?: string; - /** @description The name of the method */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ - pathname?: string; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The batch ID */ + batchid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: date-time + * @description The time when the batch was confirmed + */ + confirmed?: string; + /** + * Format: date-time + * @description The time the batch was sealed + */ + created?: string; + /** + * Format: byte + * @description The privacy group the batch is sent to, for private batches + */ + group?: string; + /** + * Format: byte + * @description The hash of the manifest of the batch + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the batch + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The manifest of the batch */ + manifest?: unknown; + /** @description The namespace of the batch */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the node that generated the batch + */ + node?: string; + /** @description The FireFly transaction associated with this batch */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of the batch + * @enum {string} + */ + type?: "broadcast" | "private"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postBatchCancel: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The batch ID */ + batchid: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": unknown; + }; + }; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getBlockchainEvents: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + listener?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description The name of the FFI - usually matching the smart contract name */ - name?: string; - /** @description The namespace of the FFI */ - namespace?: string; - /** @description The published name of the FFI within the multiparty network */ - networkName?: string; - /** @description Indicates if the FFI is published to other members of the multiparty network */ - published?: boolean; - /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The description of the FFI to be generated. Defaults to the description extracted by the blockchain specific converter utility */ - description?: string; - /** @description A blockchain connector specific payload. For example in Ethereum this is a JSON structure containing an 'abi' array, and optionally a 'devdocs' array. */ - input?: any; - /** @description The name of the FFI to generate */ - name?: string; - /** @description The namespace into which the FFI will be generated */ - namespace?: string; - /** @description The version of the FFI to generate */ - version?: string; - }; - }; - }; - }; - /** Invokes a method on a smart contract. Performs a blockchain transaction. */ - postContractInvokeNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** @description The name of the error */ - name?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface - */ - interface?: string; - /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + protocolid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + source?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + timestamp?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.blockchainid"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID assigned to the event by FireFly + */ + id?: string; + /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ + info?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace + */ + listener?: string; + /** @description The name of the event in the blockchain smart contract */ + name?: string; + /** @description The namespace of the listener that detected this blockchain event */ + namespace?: string; + /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ + output?: { + [key: string]: unknown; + }; + /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ + protocolId?: string; + /** @description The blockchain plugin or token service that detected the event */ + source?: string; + /** + * Format: date-time + * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors + */ + timestamp?: string; + /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ + tx?: { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ + blockchainId?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getBlockchainEventByID: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The blockchain event ID */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID assigned to the event by FireFly + */ + id?: string; + /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ + info?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace + */ + listener?: string; + /** @description The name of the event in the blockchain smart contract */ + name?: string; + /** @description The namespace of the listener that detected this blockchain event */ + namespace?: string; + /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ + output?: { + [key: string]: unknown; + }; + /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ + protocolId?: string; + /** @description The blockchain plugin or token service that detected the event */ + source?: string; + /** + * Format: date-time + * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors + */ + timestamp?: string; + /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ + tx?: { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ + blockchainId?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getChartHistogram: { + parameters: { + query?: { + /** @description Start time of the data to be fetched */ + startTime?: string; + /** @description End time of the data to be fetched */ + endTime?: string; + /** @description Number of buckets between start time and end time */ + buckets?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The collection ID */ + collection: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Total count of entries in this time bucket within the histogram */ + count?: string; + /** @description Indicates whether there are more results in this bucket that are not being displayed */ + isCapped?: boolean; + /** + * Format: date-time + * @description Starting timestamp for the bucket + */ + timestamp?: string; + /** @description Array of separate counts for individual types of record within the bucket */ + types?: { + /** @description Count of entries of a given type within a bucket */ + count?: string; + /** @description Name of the type */ + type?: string; + }[]; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractDeploy: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The smart contract to deploy. This should be pre-compiled if required by the blockchain connector */ + contract?: unknown; + /** @description The definition of the smart contract */ + definition?: unknown; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description An optional array of inputs passed to the smart contract's constructor, if applicable */ + input?: unknown[]; + /** @description The blockchain signing key that will be used to deploy the contract. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractInterfaces: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + networkname?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + published?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewContractInterface: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + /** @description When true the definition will be published to all other members of the multiparty network */ + publish?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** @description The name of the error */ + name?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the method */ + name?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractInterface: { + parameters: { + query?: { + /** @description When set, the API will return the full FireFly Interface document including all methods, events, and parameters */ + fetchchildren?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The ID of the contract interface */ + interfaceId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteContractInterface: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The ID of the contract interface */ + interfaceId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractInterfaceByNameAndVersion: { + parameters: { + query?: { + /** @description When set, the API will return the full FireFly Interface document including all methods, events, and parameters */ + fetchchildren?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract interface */ + name: string; + /** @description The version of the contract interface */ + version: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractInterfacePublish: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract interface */ + name: string; + /** @description The version of the contract interface */ + version: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postGenerateContractInterface: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The description of the FFI to be generated. Defaults to the description extracted by the blockchain specific converter utility */ + description?: string; + /** @description A blockchain connector specific payload. For example in Ethereum this is a JSON structure containing an 'abi' array, and optionally a 'devdocs' array. */ + input?: unknown; + /** @description The name of the FFI to generate */ + name?: string; + /** @description The namespace into which the FFI will be generated */ + namespace?: string; + /** @description The version of the FFI to generate */ + version?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractInvoke: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the blockchain transaction is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** @description The name of the error */ + name?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ + input?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface + */ + interface?: string; + /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ + method?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the method */ + name?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description The pathname of the method on the specified FFI */ + methodPath?: string; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractListeners: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + backendid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + filters?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interface?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + location?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + signature?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewContractListener: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description Deprecated: Please use 'eventPath' in the array of 'filters' instead */ + eventPath?: string; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ + eventPath?: string; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractListenerByNameOrID: { + parameters: { + query?: { + /** @description When set, the API will return additional status information if available */ + fetchstatus?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The contract listener name or ID */ + nameOrId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteContractListener: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The contract listener name or ID */ + nameOrId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractListenerSignature: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description Deprecated: Please use 'eventPath' in the array of 'filters' instead */ + eventPath?: string; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ + eventPath?: string; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractQuery: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** @description The name of the error */ + name?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ + input?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface + */ + interface?: string; + /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ + method?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the method */ + name?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description The pathname of the method on the specified FFI */ + methodPath?: string; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getData: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.hash"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.name"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.path"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.public"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.size"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "datatype.name"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "datatype.version"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + public?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + validator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + value?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postData: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }; + "multipart/form-data": { + /** @description Success */ + autometa?: string; + /** @description Success */ + "datatype.name"?: string; + /** @description Success */ + "datatype.version"?: string; + /** Format: binary */ + "filename.ext"?: string; + /** @description Success */ + metadata?: string; + /** @description Success */ + validator?: string; + }; + }; + }; + responses: { + /** @description Success */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataByID: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The data item ID */ + dataid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteData: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The data item ID */ + dataid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataBlob: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + cid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + datahash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pins?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + rejectreason?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tag?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topics?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txtype?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The data item ID */ + dataid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postDataBlobPublish: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The blob ID */ + dataid: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataMsgs: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + cid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + datahash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pins?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + rejectreason?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tag?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topics?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txtype?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The data item ID */ + dataid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataValue: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + cid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + datahash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pins?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + rejectreason?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tag?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topics?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txtype?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The blob ID */ + dataid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postDataValuePublish: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The blob ID */ + dataid: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataSubPaths: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The parent path to query */ + parent: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDatatypes: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + validator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + version?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the datatype was created + */ + created?: string; + /** + * Format: byte + * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the datatype + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this datatype to the network + */ + message?: string; + /** @description The name of the datatype */ + name?: string; + /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ + namespace?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewDatatype: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The name of the datatype */ + name?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the datatype was created + */ + created?: string; + /** + * Format: byte + * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the datatype + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this datatype to the network + */ + message?: string; + /** @description The name of the datatype */ + name?: string; + /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ + namespace?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the datatype was created + */ + created?: string; + /** + * Format: byte + * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the datatype + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this datatype to the network + */ + message?: string; + /** @description The name of the datatype */ + name?: string; + /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ + namespace?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDatatypeByName: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the datatype */ + name: string; + /** @description The version of the datatype */ + version: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the datatype was created + */ + created?: string; + /** + * Format: byte + * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the datatype + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this datatype to the network + */ + message?: string; + /** @description The name of the datatype */ + name?: string; + /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ + namespace?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getEvents: { + parameters: { + query?: { + /** @description When set, the API will return the record that this item references in its 'reference' field */ + fetchreferences?: string; + /** @description When set, the API will return the record that this item references in its 'reference' field */ + fetchreference?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + correlator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + reference?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tx?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool + */ + correlator?: string; + /** + * Format: date-time + * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications + */ + created?: string; + /** + * Format: uuid + * @description The UUID assigned to this event by your local FireFly node + */ + id?: string; + /** @description The namespace of the event. Your application must subscribe to events within a namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset + */ + reference?: string; + /** + * Format: int64 + * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) + */ + sequence?: number; + /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ + topic?: string; + /** + * Format: uuid + * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction + */ + tx?: string; + /** + * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application + * @enum {string} + */ + type?: "transaction_submitted" | "message_confirmed" | "message_rejected" | "datatype_confirmed" | "identity_confirmed" | "identity_updated" | "token_pool_confirmed" | "token_pool_op_failed" | "token_transfer_confirmed" | "token_transfer_op_failed" | "token_approval_confirmed" | "token_approval_op_failed" | "contract_interface_confirmed" | "contract_api_confirmed" | "blockchain_event_received" | "blockchain_invoke_op_succeeded" | "blockchain_invoke_op_failed" | "blockchain_contract_deploy_op_succeeded" | "blockchain_contract_deploy_op_failed"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getEventByID: { + parameters: { + query?: { + /** @description When set, the API will return the record that this item references in its 'reference' field */ + fetchreference?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The event ID */ + eid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool + */ + correlator?: string; + /** + * Format: date-time + * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications + */ + created?: string; + /** + * Format: uuid + * @description The UUID assigned to this event by your local FireFly node + */ + id?: string; + /** @description The namespace of the event. Your application must subscribe to events within a namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset + */ + reference?: string; + /** + * Format: int64 + * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) + */ + sequence?: number; + /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ + topic?: string; + /** + * Format: uuid + * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction + */ + tx?: string; + /** + * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application + * @enum {string} + */ + type?: "transaction_submitted" | "message_confirmed" | "message_rejected" | "datatype_confirmed" | "identity_confirmed" | "identity_updated" | "token_pool_confirmed" | "token_pool_op_failed" | "token_transfer_confirmed" | "token_transfer_op_failed" | "token_approval_confirmed" | "token_approval_op_failed" | "contract_interface_confirmed" | "contract_api_confirmed" | "blockchain_event_received" | "blockchain_invoke_op_succeeded" | "blockchain_invoke_op_failed" | "blockchain_contract_deploy_op_succeeded" | "blockchain_contract_deploy_op_failed"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getGroups: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + ledger?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time when the group was first used to send a message in the network + */ + created?: string; + /** + * Format: byte + * @description The identifier hash of this group. Derived from the name and group members + */ + hash?: string; + /** @description The local namespace of the group */ + localNamespace?: string; + /** @description The list of members in this privacy group */ + members?: { + /** @description The DID of the group member */ + identity?: string; + /** + * Format: uuid + * @description The UUID of the node that receives a copy of the off-chain message for the identity + */ + node?: string; + }[]; + /** + * Format: uuid + * @description The message used to broadcast this group privately to the members + */ + message?: string; + /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ + name?: string; + /** @description The namespace of the group within the multiparty network */ + namespace?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getGroupByHash: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The hash of the group */ + hash: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time when the group was first used to send a message in the network + */ + created?: string; + /** + * Format: byte + * @description The identifier hash of this group. Derived from the name and group members + */ + hash?: string; + /** @description The local namespace of the group */ + localNamespace?: string; + /** @description The list of members in this privacy group */ + members?: { + /** @description The DID of the group member */ + identity?: string; + /** + * Format: uuid + * @description The UUID of the node that receives a copy of the off-chain message for the identity + */ + node?: string; + }[]; + /** + * Format: uuid + * @description The message used to broadcast this group privately to the members + */ + message?: string; + /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ + name?: string; + /** @description The namespace of the group within the multiparty network */ + namespace?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getIdentities: { + parameters: { + query?: { + /** @description When set, the API will return the verifier for this identity */ + fetchverifiers?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + did?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.claim"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.update"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.verification"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + parent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + profile?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ + verifiers?: { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewIdentity: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The blockchain signing key to use to make the claim to the identity. Must be available to the local node to sign the identity claim. Will become a verifier on the established identity */ + key?: string; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** @description The type of the identity */ + type?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getIdentityByID: { + parameters: { + query?: { + /** @description When set, the API will return the verifier for this identity */ + fetchverifiers?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity ID, which is a UUID generated by FireFly */ + iid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + patchUpdateIdentity: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity ID, which is a UUID generated by FireFly */ + iid: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getIdentityDID: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity ID, which is a UUID generated by FireFly */ + iid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description See https://www.w3.org/TR/did-core/#json-ld */ + "@context"?: string[]; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + authentication?: string[]; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + id?: string; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + verificationMethod?: { + /** @description For blockchains like Ethereum that represent signing identities directly by their public key summarized in an account string */ + blockchainAcountId?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + controller?: string; + /** @description A string provided by your Data Exchange plugin, that it uses a technology specific mechanism to validate against when messages arrive from this identity */ + dataExchangePeerID?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + id?: string; + /** @description For Hyperledger Fabric where the signing identity is represented by an MSP identifier (containing X509 certificate DN strings) that were validated by your local MSP */ + mspIdentityString?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + type?: string; + }[]; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getIdentityVerifiers: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + identity?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + value?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity ID, which is a UUID generated by FireFly */ + iid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time this verifier was created on this node + */ + created?: string; + /** + * Format: byte + * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the parent identity that has claimed this verifier + */ + identity?: string; + /** @description The namespace of the verifier */ + namespace?: string; + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgs: { + parameters: { + query?: { + /** @description Fetch the data and include it in the messages returned */ + fetchdata?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + cid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + datahash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pins?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + rejectreason?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tag?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topics?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txtype?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgByID: { + parameters: { + query?: { + /** @description Fetch the data and include it in the messages returned */ + fetchdata?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The message ID */ + msgid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description An optional in-line hash reference to a previously uploaded binary data blob */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgData: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The message ID */ + msgid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgEvents: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + correlator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + reference?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tx?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The message ID */ + msgid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool + */ + correlator?: string; + /** + * Format: date-time + * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications + */ + created?: string; + /** + * Format: uuid + * @description The UUID assigned to this event by your local FireFly node + */ + id?: string; + /** @description The namespace of the event. Your application must subscribe to events within a namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset + */ + reference?: string; + /** + * Format: int64 + * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) + */ + sequence?: number; + /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ + topic?: string; + /** + * Format: uuid + * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction + */ + tx?: string; + /** + * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application + * @enum {string} + */ + type?: "transaction_submitted" | "message_confirmed" | "message_rejected" | "datatype_confirmed" | "identity_confirmed" | "identity_updated" | "token_pool_confirmed" | "token_pool_op_failed" | "token_transfer_confirmed" | "token_transfer_op_failed" | "token_approval_confirmed" | "token_approval_op_failed" | "contract_interface_confirmed" | "contract_api_confirmed" | "blockchain_event_received" | "blockchain_invoke_op_succeeded" | "blockchain_invoke_op_failed" | "blockchain_contract_deploy_op_succeeded" | "blockchain_contract_deploy_op_failed"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgTxn: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The message ID */ + msgid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ + blockchainIds?: string[]; + /** + * Format: date-time + * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction + */ + created?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ + idempotencyKey?: string; + /** @description The namespace of the FireFly transaction */ + namespace?: string; + /** + * @description The type of the FireFly transaction + * @enum {string} + */ + type?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewMessageBroadcast: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewMessagePrivate: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewMessageRequestReply: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description An optional in-line hash reference to a previously uploaded binary data blob */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNamespaces: { + parameters: { + query?: { + /** @description When set, the API will return namespaces even if they are not yet initialized, including in error cases where an initializationError is included */ + includeinitializing?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the namespace was created + */ + created?: string; + /** @description A description of the namespace */ + description?: string; + /** @description Set to a non-empty string in the case that the namespace is currently failing to initialize */ + initializationError?: string; + /** @description Set to true if the namespace is still initializing */ + initializing?: boolean; + /** @description The local namespace name */ + name?: string; + /** @description The shared namespace name within the multiparty network */ + networkName?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the namespace was created + */ + created?: string; + /** @description A description of the namespace */ + description?: string; + /** @description The local namespace name */ + name?: string; + /** @description The shared namespace name within the multiparty network */ + networkName?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractAPIsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interface?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + networkname?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + published?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewContractAPINamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + /** @description When true the definition will be published to all other members of the multiparty network */ + publish?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractAPIByNameNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + putContractAPINamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + id: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the contract API + */ + id?: string; + /** @description Reference to the FireFly Interface definition associated with the contract API */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this API to the network + */ + message?: string; + /** @description The name that is used in the URL to access the API */ + name?: string; + /** @description The namespace of the contract API */ + namespace?: string; + /** @description The published name of the API within the multiparty network */ + networkName?: string; + /** @description Indicates if the API is published to other members of the multiparty network */ + published?: boolean; + /** @description The URLs to use to access the API */ + urls?: { + /** @description The URL to use to invoke the API */ + api?: string; + /** @description The URL to download the OpenAPI v3 (Swagger) description for the API generated in JSON or YAML format */ + openapi?: string; + /** @description The URL to use in a web browser to access the SwaggerUI explorer/exerciser for the API */ + ui?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteContractAPINamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractAPIInterfaceNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractAPIInvokeNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The name or uniquely generated path name of a method on a smart contract */ + methodPath: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** @description The name of the error */ + name?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ + input?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface + */ + interface?: string; + /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ + method?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the method */ + name?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description The pathname of the method on the specified FFI */ + methodPath?: string; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractAPIListenersNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + backendid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + filters?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interface?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + location?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + signature?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The name or uniquely generated path name of a event on a smart contract */ + eventPath: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractAPIListenersNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The name or uniquely generated path name of a event on a smart contract */ + eventPath: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractAPIPublishNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractAPIQueryNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract API */ + apiName: string; + /** @description The name or uniquely generated path name of a method on a smart contract */ + methodPath: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** @description The name of the error */ + name?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ + input?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface + */ + interface?: string; + /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ + method?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the method */ + name?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description The pathname of the method on the specified FFI */ + methodPath?: string; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getBatchesNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + node?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + payloadref?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: date-time + * @description The time when the batch was confirmed + */ + confirmed?: string; + /** + * Format: date-time + * @description The time the batch was sealed + */ + created?: string; + /** + * Format: byte + * @description The privacy group the batch is sent to, for private batches + */ + group?: string; + /** + * Format: byte + * @description The hash of the manifest of the batch + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the batch + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The manifest of the batch */ + manifest?: unknown; + /** @description The namespace of the batch */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the node that generated the batch + */ + node?: string; + /** @description The FireFly transaction associated with this batch */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of the batch + * @enum {string} + */ + type?: "broadcast" | "private"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getBatchByIDNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The batch ID */ + batchid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: date-time + * @description The time when the batch was confirmed + */ + confirmed?: string; + /** + * Format: date-time + * @description The time the batch was sealed + */ + created?: string; + /** + * Format: byte + * @description The privacy group the batch is sent to, for private batches + */ + group?: string; + /** + * Format: byte + * @description The hash of the manifest of the batch + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the batch + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The manifest of the batch */ + manifest?: unknown; + /** @description The namespace of the batch */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the node that generated the batch + */ + node?: string; + /** @description The FireFly transaction associated with this batch */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of the batch + * @enum {string} + */ + type?: "broadcast" | "private"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postBatchCancelNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The batch ID */ + batchid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": unknown; + }; + }; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getBlockchainEventsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + listener?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + protocolid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + source?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + timestamp?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.blockchainid"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID assigned to the event by FireFly + */ + id?: string; + /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ + info?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace + */ + listener?: string; + /** @description The name of the event in the blockchain smart contract */ + name?: string; + /** @description The namespace of the listener that detected this blockchain event */ + namespace?: string; + /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ + output?: { + [key: string]: unknown; + }; + /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ + protocolId?: string; + /** @description The blockchain plugin or token service that detected the event */ + source?: string; + /** + * Format: date-time + * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors + */ + timestamp?: string; + /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ + tx?: { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ + blockchainId?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getBlockchainEventByIDNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The blockchain event ID */ + id: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID assigned to the event by FireFly + */ + id?: string; + /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ + info?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace + */ + listener?: string; + /** @description The name of the event in the blockchain smart contract */ + name?: string; + /** @description The namespace of the listener that detected this blockchain event */ + namespace?: string; + /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ + output?: { + [key: string]: unknown; + }; + /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ + protocolId?: string; + /** @description The blockchain plugin or token service that detected the event */ + source?: string; + /** + * Format: date-time + * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors + */ + timestamp?: string; + /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ + tx?: { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ + blockchainId?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getChartHistogramNamespace: { + parameters: { + query?: { + /** @description Start time of the data to be fetched */ + startTime?: string; + /** @description End time of the data to be fetched */ + endTime?: string; + /** @description Number of buckets between start time and end time */ + buckets?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The collection ID */ + collection: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Total count of entries in this time bucket within the histogram */ + count?: string; + /** @description Indicates whether there are more results in this bucket that are not being displayed */ + isCapped?: boolean; + /** + * Format: date-time + * @description Starting timestamp for the bucket + */ + timestamp?: string; + /** @description Array of separate counts for individual types of record within the bucket */ + types?: { + /** @description Count of entries of a given type within a bucket */ + count?: string; + /** @description Name of the type */ + type?: string; + }[]; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractDeployNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The smart contract to deploy. This should be pre-compiled if required by the blockchain connector */ + contract?: unknown; + /** @description The definition of the smart contract */ + definition?: unknown; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description An optional array of inputs passed to the smart contract's constructor, if applicable */ + input?: unknown[]; + /** @description The blockchain signing key that will be used to deploy the contract. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractInterfacesNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + networkname?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + published?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + version?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewContractInterfaceNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + /** @description When true the definition will be published to all other members of the multiparty network */ + publish?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** @description The name of the error */ + name?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the method */ + name?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractInterfaceNamespace: { + parameters: { + query?: { + /** @description When set, the API will return the full FireFly Interface document including all methods, events, and parameters */ + fetchchildren?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The ID of the contract interface */ + interfaceId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteContractInterfaceNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The ID of the contract interface */ + interfaceId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractInterfaceByNameAndVersionNamespace: { + parameters: { + query?: { + /** @description When set, the API will return the full FireFly Interface document including all methods, events, and parameters */ + fetchchildren?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract interface */ + name: string; + /** @description The version of the contract interface */ + version: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractInterfacePublishNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the contract interface */ + name: string; + /** @description The version of the contract interface */ + version: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postGenerateContractInterfaceNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The description of the FFI to be generated. Defaults to the description extracted by the blockchain specific converter utility */ + description?: string; + /** @description A blockchain connector specific payload. For example in Ethereum this is a JSON structure containing an 'abi' array, and optionally a 'devdocs' array. */ + input?: unknown; + /** @description The name of the FFI to generate */ + name?: string; + /** @description The namespace into which the FFI will be generated */ + namespace?: string; + /** @description The version of the FFI to generate */ + version?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A description of the smart contract this FFI represents */ + description?: string; + /** @description An array of smart contract error definitions */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** + * Format: uuid + * @description The UUID of the FFI error definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this error is part of + */ + interface?: string; + /** @description The name of the error */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this error within the FFI for use on URL paths */ + pathname?: string; + /** @description The stringified signature of the error, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** @description An array of smart contract event definitions */ + events?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI event definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this event is part of + */ + interface?: string; + /** @description The name of the event */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ + pathname?: string; + /** @description The stringified signature of the event, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the FireFly interface (FFI) smart contract definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this FFI to the network + */ + message?: string; + /** @description An array of smart contract method definitions */ + methods?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the FFI method definition + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the FFI smart contract definition that this method is part of + */ + interface?: string; + /** @description The name of the method */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ + pathname?: string; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description The name of the FFI - usually matching the smart contract name */ + name?: string; + /** @description The namespace of the FFI */ + namespace?: string; + /** @description The published name of the FFI within the multiparty network */ + networkName?: string; + /** @description Indicates if the FFI is published to other members of the multiparty network */ + published?: boolean; + /** @description A version for the FFI - use of semantic versioning such as 'v1.0.1' is encouraged */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractInvokeNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the blockchain transaction is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** @description The name of the error */ + name?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ + input?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface + */ + interface?: string; + /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ + method?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the method */ + name?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description The pathname of the method on the specified FFI */ + methodPath?: string; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractListenersNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + backendid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + filters?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interface?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + location?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + signature?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewContractListenerNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description Deprecated: Please use 'eventPath' in the array of 'filters' instead */ + eventPath?: string; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ + eventPath?: string; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getContractListenerByNameOrIDNamespace: { + parameters: { + query?: { + /** @description When set, the API will return additional status information if available */ + fetchstatus?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The contract listener name or ID */ + nameOrId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An ID assigned by the blockchain connector to this listener */ + backendId?: string; + /** + * Format: date-time + * @description The creation time of the listener + */ + created?: string; + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }[]; + /** + * Format: uuid + * @description The UUID of the smart contract listener + */ + id?: string; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ + namespace?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteContractListenerNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The contract listener name or ID */ + nameOrId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractListenerSignatureNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description Deprecated: Please use 'eventPath' in the array of 'filters' instead */ + eventPath?: string; + /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ + filters?: { + /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ + event?: { + /** @description A description of the smart contract event */ + description?: string; + /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the event */ + name?: string; + /** @description An array of event parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ + eventPath?: string; + /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ + location?: unknown; + /** @description A descriptive name for the listener */ + name?: string; + /** @description Options that control how the listener subscribes to events from the underlying blockchain */ + options?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ + firstEvent?: string; + }; + /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ + topic?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ + signature?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postContractQueryNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ + errors?: { + /** @description A description of the smart contract error */ + description?: string; + /** @description The name of the error */ + name?: string; + /** @description An array of error parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }[]; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ + input?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface + */ + interface?: string; + /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ + method?: { + /** @description A description of the smart contract method */ + description?: string; + /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ + details?: { + [key: string]: unknown; + }; + /** @description The name of the method */ + name?: string; + /** @description An array of method parameter/argument definitions */ + params?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + /** @description An array of method return definitions */ + returns?: { + /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ + name?: string; + /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ + schema?: unknown; + }[]; + }; + /** @description The pathname of the method on the specified FFI */ + methodPath?: string; + /** @description A map of named inputs that will be passed through to the blockchain connector */ + options?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.hash"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.name"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.path"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.public"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "blob.size"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "datatype.name"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "datatype.version"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + public?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + validator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + value?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postDataNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }; + "multipart/form-data": { + /** @description Success */ + autometa?: string; + /** @description Success */ + "datatype.name"?: string; + /** @description Success */ + "datatype.version"?: string; + /** Format: binary */ + "filename.ext"?: string; + /** @description Success */ + metadata?: string; + /** @description Success */ + validator?: string; + }; + }; + }; + responses: { + /** @description Success */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataByIDNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The data item ID */ + dataid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteDataNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The data item ID */ + dataid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataBlobNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + cid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + datahash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pins?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + rejectreason?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tag?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topics?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txtype?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The data item ID */ + dataid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postDataBlobPublishNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The blob ID */ + dataid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataMsgsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + cid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + datahash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pins?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + rejectreason?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tag?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topics?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txtype?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The data item ID */ + dataid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataValueNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + cid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + datahash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pins?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + rejectreason?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tag?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topics?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txtype?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The blob ID */ + dataid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postDataValuePublishNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The blob ID */ + dataid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDataSubPathsNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The parent path to query */ + parent: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDatatypesNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + validator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + version?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the datatype was created + */ + created?: string; + /** + * Format: byte + * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the datatype + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this datatype to the network + */ + message?: string; + /** @description The name of the datatype */ + name?: string; + /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ + namespace?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewDatatypeNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The name of the datatype */ + name?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the datatype was created + */ + created?: string; + /** + * Format: byte + * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the datatype + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this datatype to the network + */ + message?: string; + /** @description The name of the datatype */ + name?: string; + /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ + namespace?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the datatype was created + */ + created?: string; + /** + * Format: byte + * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the datatype + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this datatype to the network + */ + message?: string; + /** @description The name of the datatype */ + name?: string; + /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ + namespace?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getDatatypeByNameNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name of the datatype */ + name: string; + /** @description The version of the datatype */ + version: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the datatype was created + */ + created?: string; + /** + * Format: byte + * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the datatype + */ + id?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message that was used to publish this datatype to the network + */ + message?: string; + /** @description The name of the datatype */ + name?: string; + /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ + namespace?: string; + /** + * @description The validator that should be used to verify this datatype + * @enum {string} + */ + validator?: "json" | "none" | "definition"; + /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ + value?: unknown; + /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ + version?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getEventsNamespace: { + parameters: { + query?: { + /** @description When set, the API will return the record that this item references in its 'reference' field */ + fetchreferences?: string; + /** @description When set, the API will return the record that this item references in its 'reference' field */ + fetchreference?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + correlator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + reference?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tx?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool + */ + correlator?: string; + /** + * Format: date-time + * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications + */ + created?: string; + /** + * Format: uuid + * @description The UUID assigned to this event by your local FireFly node + */ + id?: string; + /** @description The namespace of the event. Your application must subscribe to events within a namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset + */ + reference?: string; + /** + * Format: int64 + * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) + */ + sequence?: number; + /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ + topic?: string; + /** + * Format: uuid + * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction + */ + tx?: string; + /** + * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application + * @enum {string} + */ + type?: "transaction_submitted" | "message_confirmed" | "message_rejected" | "datatype_confirmed" | "identity_confirmed" | "identity_updated" | "token_pool_confirmed" | "token_pool_op_failed" | "token_transfer_confirmed" | "token_transfer_op_failed" | "token_approval_confirmed" | "token_approval_op_failed" | "contract_interface_confirmed" | "contract_api_confirmed" | "blockchain_event_received" | "blockchain_invoke_op_succeeded" | "blockchain_invoke_op_failed" | "blockchain_contract_deploy_op_succeeded" | "blockchain_contract_deploy_op_failed"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getEventByIDNamespace: { + parameters: { + query?: { + /** @description When set, the API will return the record that this item references in its 'reference' field */ + fetchreference?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The event ID */ + eid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool + */ + correlator?: string; + /** + * Format: date-time + * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications + */ + created?: string; + /** + * Format: uuid + * @description The UUID assigned to this event by your local FireFly node + */ + id?: string; + /** @description The namespace of the event. Your application must subscribe to events within a namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset + */ + reference?: string; + /** + * Format: int64 + * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) + */ + sequence?: number; + /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ + topic?: string; + /** + * Format: uuid + * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction + */ + tx?: string; + /** + * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application + * @enum {string} + */ + type?: "transaction_submitted" | "message_confirmed" | "message_rejected" | "datatype_confirmed" | "identity_confirmed" | "identity_updated" | "token_pool_confirmed" | "token_pool_op_failed" | "token_transfer_confirmed" | "token_transfer_op_failed" | "token_approval_confirmed" | "token_approval_op_failed" | "contract_interface_confirmed" | "contract_api_confirmed" | "blockchain_event_received" | "blockchain_invoke_op_succeeded" | "blockchain_invoke_op_failed" | "blockchain_contract_deploy_op_succeeded" | "blockchain_contract_deploy_op_failed"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getGroupsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + ledger?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time when the group was first used to send a message in the network + */ + created?: string; + /** + * Format: byte + * @description The identifier hash of this group. Derived from the name and group members + */ + hash?: string; + /** @description The local namespace of the group */ + localNamespace?: string; + /** @description The list of members in this privacy group */ + members?: { + /** @description The DID of the group member */ + identity?: string; + /** + * Format: uuid + * @description The UUID of the node that receives a copy of the off-chain message for the identity + */ + node?: string; + }[]; + /** + * Format: uuid + * @description The message used to broadcast this group privately to the members + */ + message?: string; + /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ + name?: string; + /** @description The namespace of the group within the multiparty network */ + namespace?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getGroupByHashNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The hash of the group */ + hash: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time when the group was first used to send a message in the network + */ + created?: string; + /** + * Format: byte + * @description The identifier hash of this group. Derived from the name and group members + */ + hash?: string; + /** @description The local namespace of the group */ + localNamespace?: string; + /** @description The list of members in this privacy group */ + members?: { + /** @description The DID of the group member */ + identity?: string; + /** + * Format: uuid + * @description The UUID of the node that receives a copy of the off-chain message for the identity + */ + node?: string; + }[]; + /** + * Format: uuid + * @description The message used to broadcast this group privately to the members + */ + message?: string; + /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ + name?: string; + /** @description The namespace of the group within the multiparty network */ + namespace?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getIdentitiesNamespace: { + parameters: { + query?: { + /** @description When set, the API will return the verifier for this identity */ + fetchverifiers?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + did?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.claim"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.update"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.verification"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + parent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + profile?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ + verifiers?: { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewIdentityNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The blockchain signing key to use to make the claim to the identity. Must be available to the local node to sign the identity claim. Will become a verifier on the established identity */ + key?: string; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** @description The type of the identity */ + type?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getIdentityByIDNamespace: { + parameters: { + query?: { + /** @description When set, the API will return the verifier for this identity */ + fetchverifiers?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity ID, which is a UUID generated by FireFly */ + iid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + patchUpdateIdentityNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity ID, which is a UUID generated by FireFly */ + iid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getIdentityDIDNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity ID, which is a UUID generated by FireFly */ + iid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description See https://www.w3.org/TR/did-core/#json-ld */ + "@context"?: string[]; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + authentication?: string[]; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + id?: string; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + verificationMethod?: { + /** @description For blockchains like Ethereum that represent signing identities directly by their public key summarized in an account string */ + blockchainAcountId?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + controller?: string; + /** @description A string provided by your Data Exchange plugin, that it uses a technology specific mechanism to validate against when messages arrive from this identity */ + dataExchangePeerID?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + id?: string; + /** @description For Hyperledger Fabric where the signing identity is represented by an MSP identifier (containing X509 certificate DN strings) that were validated by your local MSP */ + mspIdentityString?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + type?: string; + }[]; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getIdentityVerifiersNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + identity?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + value?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity ID, which is a UUID generated by FireFly */ + iid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time this verifier was created on this node + */ + created?: string; + /** + * Format: byte + * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the parent identity that has claimed this verifier + */ + identity?: string; + /** @description The namespace of the verifier */ + namespace?: string; + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgsNamespace: { + parameters: { + query?: { + /** @description Fetch the data and include it in the messages returned */ + fetchdata?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + author?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + cid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + confirmed?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + datahash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + group?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pins?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + rejectreason?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + state?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tag?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topics?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "txparent.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + txtype?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgByIDNamespace: { + parameters: { + query?: { + /** @description Fetch the data and include it in the messages returned */ + fetchdata?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The message ID */ + msgid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description An optional in-line hash reference to a previously uploaded binary data blob */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgDataNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The message ID */ + msgid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An optional hash reference to a binary blob attachment */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** + * Format: date-time + * @description The creation time of the data resource + */ + created?: string; + /** @description The optional datatype to use of validation of this data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the data resource + */ + id?: string; + /** @description The namespace of the data resource */ + namespace?: string; + /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** @description The data validator type */ + validator?: string; + /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ + value?: unknown; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgEventsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + correlator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + reference?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tx?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The message ID */ + msgid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool + */ + correlator?: string; + /** + * Format: date-time + * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications + */ + created?: string; + /** + * Format: uuid + * @description The UUID assigned to this event by your local FireFly node + */ + id?: string; + /** @description The namespace of the event. Your application must subscribe to events within a namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset + */ + reference?: string; + /** + * Format: int64 + * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) + */ + sequence?: number; + /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ + topic?: string; + /** + * Format: uuid + * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction + */ + tx?: string; + /** + * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application + * @enum {string} + */ + type?: "transaction_submitted" | "message_confirmed" | "message_rejected" | "datatype_confirmed" | "identity_confirmed" | "identity_updated" | "token_pool_confirmed" | "token_pool_op_failed" | "token_transfer_confirmed" | "token_transfer_op_failed" | "token_approval_confirmed" | "token_approval_op_failed" | "contract_interface_confirmed" | "contract_api_confirmed" | "blockchain_event_received" | "blockchain_invoke_op_succeeded" | "blockchain_invoke_op_failed" | "blockchain_contract_deploy_op_succeeded" | "blockchain_contract_deploy_op_failed"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getMsgTxnNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The message ID */ + msgid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ + blockchainIds?: string[]; + /** + * Format: date-time + * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction + */ + created?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ + idempotencyKey?: string; + /** @description The namespace of the FireFly transaction */ + namespace?: string; + /** + * @description The type of the FireFly transaction + * @enum {string} + */ + type?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewMessageBroadcastNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewMessagePrivateNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description The list of data elements attached to the message */ + data?: { + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + }[]; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewMessageRequestReplyNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch in which the message was pinned/transferred + */ + batch?: string; + /** + * Format: date-time + * @description The timestamp of when the message was confirmed/rejected + */ + confirmed?: string; + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description An optional in-line hash reference to a previously uploaded binary data blob */ + blob?: { + /** + * Format: byte + * @description The hash of the binary blob data + */ + hash?: string; + /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ + name?: string; + /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ + path?: string; + /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ + public?: string; + /** + * Format: int64 + * @description The size of the binary data + */ + size?: number; + }; + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: byte + * @description The hash of the referenced data + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** + * Format: byte + * @description The hash of the message. Derived from the header, which includes the data hash + */ + hash?: string; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: date-time + * @description The creation time of the message + */ + created?: string; + /** + * Format: byte + * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message + */ + datahash?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** + * Format: uuid + * @description The UUID of the message. Unique to each message + */ + id?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The namespace of the message within the multiparty network */ + namespace?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** @description The parent transaction that originally triggered this message */ + txparent?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + /** @description The local namespace of the message */ + localNamespace?: string; + /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ + pins?: string[]; + /** @description If a message was rejected, provides details on the rejection reason */ + rejectReason?: string; + /** + * @description The current state of the message + * @enum {string} + */ + state?: "staged" | "ready" | "sent" | "pending" | "confirmed" | "rejected" | "cancelled"; + /** + * Format: uuid + * @description The ID of the transaction used to order/deliver this message + */ + txid?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNetworkActionNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * @description The action to be performed + * @enum {string} + */ + type?: "terminate"; + }; + }; + }; + responses: { + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The action to be performed + * @enum {string} + */ + type?: "terminate"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkDIDDocByDIDNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity DID */ + did: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description See https://www.w3.org/TR/did-core/#json-ld */ + "@context"?: string[]; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + authentication?: string[]; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + id?: string; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + verificationMethod?: { + /** @description For blockchains like Ethereum that represent signing identities directly by their public key summarized in an account string */ + blockchainAcountId?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + controller?: string; + /** @description A string provided by your Data Exchange plugin, that it uses a technology specific mechanism to validate against when messages arrive from this identity */ + dataExchangePeerID?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + id?: string; + /** @description For Hyperledger Fabric where the signing identity is represented by an MSP identifier (containing X509 certificate DN strings) that were validated by your local MSP */ + mspIdentityString?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + type?: string; + }[]; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkIdentitiesNamespace: { + parameters: { + query?: { + /** @description When set, the API will return the verifier for this identity */ + fetchverifiers?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + did?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.claim"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.update"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.verification"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + parent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + profile?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ + verifiers?: { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkIdentityByDIDNamespace: { + parameters: { + query?: { + /** @description When set, the API will return the verifier for this identity */ + fetchverifiers?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity DID */ + did: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ + verifiers?: { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkNodesNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + did?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.claim"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.update"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.verification"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + parent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + profile?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkNodeNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name or ID of the node */ + nameOrId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNodesSelfNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkOrgsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + did?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.claim"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.update"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.verification"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + parent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + profile?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewOrganizationNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The blockchain signing key to use to make the claim to the identity. Must be available to the local node to sign the identity claim. Will become a verifier on the established identity */ + key?: string; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** @description The type of the identity */ + type?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkOrgNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name or ID of the org */ + nameOrId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewOrganizationSelfNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNextPinsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + context?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + identity?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + nonce?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: byte + * @description The context the next-pin applies to - the hash of the privacy group-hash + topic. The group-hash is only known to the participants (can itself contain a salt in the group-name). This context is combined with the member and nonce to determine the final hash that is written on-chain + */ + context?: string; + /** + * Format: byte + * @description The unique masked pin string + */ + hash?: string; + /** @description The member of the privacy group the next-pin applies to */ + identity?: string; + /** @description The namespace of the next-pin */ + namespace?: string; + /** + * Format: int64 + * @description The numeric index - which is monotonically increasing for each member of the privacy group + */ + nonce?: number; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getOpsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + error?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + input?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + output?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + plugin?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + retry?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + status?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tx?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getOpByIDNamespace: { + parameters: { + query?: { + /** @description When set, the API will return additional status information if available */ + fetchstatus?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The operation ID key to get */ + opid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Additional detailed information about an operation provided by the connector */ + detail?: unknown; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postOpRetryNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The UUID of the operation */ + opid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + responses: { + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getPinsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + dispatched?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + index?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + masked?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch of messages this pin is part of + */ + batch?: string; + /** + * Format: byte + * @description The manifest hash batch of messages this pin is part of + */ + batchHash?: string; + /** + * Format: date-time + * @description The time the FireFly node created the pin + */ + created?: string; + /** @description Once true, this pin has been processed and will not be processed again */ + dispatched?: boolean; + /** + * Format: byte + * @description The hash represents a topic within a message in the batch. If a message has multiple topics, then multiple pins are created. If the message is private, the hash is masked for privacy + */ + hash?: string; + /** + * Format: int64 + * @description The index of this pin within the batch. One pin is created for each topic, of each message in the batch + */ + index?: number; + /** @description True if the pin is for a private message, and hence is masked with the group ID and salted with a nonce so observers of the blockchain cannot use pin hash to match this transaction to other transactions or participants */ + masked?: boolean; + /** @description The namespace of the pin */ + namespace?: string; + /** + * Format: int64 + * @description The order of the pin in the local FireFly database, which matches the order in which pins were delivered to FireFly by the blockchain connector event stream + */ + sequence?: number; + /** @description The blockchain signing key that submitted this transaction, as passed through to FireFly by the smart contract that emitted the blockchain event */ + signer?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postPinsRewindNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * Format: uuid + * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified + */ + batch?: string; + /** + * Format: int64 + * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified + */ + sequence?: number; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified + */ + batch?: string; + /** + * Format: int64 + * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified + */ + sequence?: number; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getStatusNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Information about the multi-party system configured on this namespace */ + multiparty?: { + /** @description Information about the multi-party smart contract configured for this namespace */ + contract?: { + /** @description The currently active FireFly smart contract */ + active?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ + firstEvent?: string; + /** @description The index of this contract in the config file */ + index?: number; + /** @description Additional info about the current status of the multi-party contract */ + info?: { + /** @description The identifier for the final blockchain event received from this contract before termination */ + finalEvent?: string; + /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ + subscription?: string; + /** @description The version of this multiparty contract */ + version?: number; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }; + /** @description Previously-terminated FireFly smart contracts */ + terminated?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ + firstEvent?: string; + /** @description The index of this contract in the config file */ + index?: number; + /** @description Additional info about the current status of the multi-party contract */ + info?: { + /** @description The identifier for the final blockchain event received from this contract before termination */ + finalEvent?: string; + /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ + subscription?: string; + /** @description The version of this multiparty contract */ + version?: number; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + }; + /** @description Whether multi-party mode is enabled for this namespace */ + enabled?: boolean; + }; + /** @description The namespace that this status applies to */ + namespace?: { + /** + * Format: date-time + * @description The time the namespace was created + */ + created?: string; + /** @description A description of the namespace */ + description?: string; + /** @description The local namespace name */ + name?: string; + /** @description The shared namespace name within the multiparty network */ + networkName?: string; + }; + /** @description Details of the local node */ + node?: { + /** + * Format: uuid + * @description The UUID of the node, if registered + */ + id?: string; + /** @description The name of this node, as specified in the local configuration */ + name?: string; + /** @description Whether the node has been successfully registered */ + registered?: boolean; + }; + /** @description Details of the root organization identity registered for this namespace on the local node */ + org?: { + /** @description The DID of the organization identity, if registered */ + did?: string; + /** + * Format: uuid + * @description The UUID of the organization, if registered + */ + id?: string; + /** @description The name of the node operator organization, as specified in the local configuration */ + name?: string; + /** @description Whether the organization has been successfully registered */ + registered?: boolean; + /** @description Array of verifiers (blockchain keys) owned by this identity */ + verifiers?: { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }; + /** @description Information about plugins configured on this namespace */ + plugins?: { + /** @description The blockchain plugins on this namespace */ + blockchain?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The data exchange plugins on this namespace */ + dataExchange?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The database plugins on this namespace */ + database?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The event plugins on this namespace */ + events?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The identity plugins on this namespace */ + identity?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The shared storage plugins on this namespace */ + sharedStorage?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The token plugins on this namespace */ + tokens?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getStatusBatchManagerNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An array of currently active batch processors */ + processors?: { + /** @description The type of dispatcher for this processor */ + dispatcher?: string; + /** @description The name of the processor, which includes details of the attributes of message are allocated to this processor */ + name?: string; + /** @description The flush status for this batch processor */ + status?: { + /** + * Format: int64 + * @description The average byte size of each batch + */ + averageBatchBytes?: number; + /** + * Format: double + * @description The average number of data attachments included in each batch + */ + averageBatchData?: number; + /** + * Format: double + * @description The average number of messages included in each batch + */ + averageBatchMessages?: number; + /** + * Format: int64 + * @description The average amount of time spent flushing each batch + */ + averageFlushTimeMS?: number; + /** @description True if the batch flush is in a retry loop, due to errors being returned by the plugins */ + blocked?: boolean; + /** @description True if the current batch flush has been cancelled */ + cancelled?: boolean; + /** + * Format: uuid + * @description If a flush is in progress, this is the UUID of the batch being flushed + */ + flushing?: string; + /** @description The last error received by this batch processor while flushing */ + lastFlushError?: string; + /** + * Format: date-time + * @description The time of the last flush + */ + lastFlushErrorTime?: string; + /** + * Format: date-time + * @description The last time a flush was performed + */ + lastFlushStartTime?: string; + /** + * Format: int64 + * @description The total count of batches flushed by this processor since it started + */ + totalBatches?: number; + /** + * Format: int64 + * @description The total count of error flushed encountered by this processor since it started + */ + totalErrors?: number; + }; + }[]; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getStatusMultipartyNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Information about the active and terminated multi-party smart contracts configured for this namespace */ + contracts?: { + /** @description The currently active FireFly smart contract */ + active?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ + firstEvent?: string; + /** @description The index of this contract in the config file */ + index?: number; + /** @description Additional info about the current status of the multi-party contract */ + info?: { + /** @description The identifier for the final blockchain event received from this contract before termination */ + finalEvent?: string; + /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ + subscription?: string; + /** @description The version of this multiparty contract */ + version?: number; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The status of the contract listener. One of 'syncing', 'synced', or 'unknown' */ + status?: string; + }; + /** @description Previously-terminated FireFly smart contracts */ + terminated?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ + firstEvent?: string; + /** @description The index of this contract in the config file */ + index?: number; + /** @description Additional info about the current status of the multi-party contract */ + info?: { + /** @description The identifier for the final blockchain event received from this contract before termination */ + finalEvent?: string; + /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ + subscription?: string; + /** @description The version of this multiparty contract */ + version?: number; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + }; + /** @description Whether multi-party mode is enabled for this namespace */ + enabled?: boolean; + /** @description Details of the local node */ + node?: { + /** + * Format: uuid + * @description The ID of the pending message that broadcast the identity claim to the network + */ + pendingRegistrationMessageId?: string; + /** @description The status of the node registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ + status?: string; + }; + /** @description Details of the root organization identity registered for this namespace on the local node */ + org?: { + /** + * Format: uuid + * @description The ID of the pending message that broadcast the identity claim to the network + */ + pendingRegistrationMessageId?: string; + /** @description The status of the organization registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ + status?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getSubscriptionsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + events?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + filters?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + options?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + transport?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description Creation time of the subscription + */ + created?: string; + /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ + ephemeral?: boolean; + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** + * Format: uuid + * @description The UUID of the subscription + */ + id?: string; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + /** + * Format: date-time + * @description Last time the subscription was updated + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + putSubscriptionNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description Creation time of the subscription + */ + created?: string; + /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ + ephemeral?: boolean; + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** + * Format: uuid + * @description The UUID of the subscription + */ + id?: string; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + /** + * Format: date-time + * @description Last time the subscription was updated + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewSubscriptionNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + }; + }; + }; + responses: { + /** @description Success */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description Creation time of the subscription + */ + created?: string; + /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ + ephemeral?: boolean; + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** + * Format: uuid + * @description The UUID of the subscription + */ + id?: string; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + /** + * Format: date-time + * @description Last time the subscription was updated + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getSubscriptionByIDNamespace: { + parameters: { + query?: { + /** @description When set, the API will return additional status information if available */ + fetchstatus?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The subscription ID */ + subid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description Creation time of the subscription + */ + created?: string; + /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ + ephemeral?: boolean; + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** + * Format: uuid + * @description The UUID of the subscription + */ + id?: string; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + /** + * Format: date-time + * @description Last time the subscription was updated + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteSubscriptionNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The subscription ID */ + subid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getSubscriptionEventsFilteredNamespace: { + parameters: { + query?: { + /** @description The sequence ID in the raw event stream to start indexing through events from. Leave blank to start indexing from the most recent events */ + startsequence?: string; + /** @description The sequence ID in the raw event stream to stop indexing through events at. Leave blank to start indexing from the most recent events */ + endsequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + correlator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + reference?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tx?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The subscription ID */ + subid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool + */ + correlator?: string; + /** + * Format: date-time + * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications + */ + created?: string; + /** + * Format: uuid + * @description The UUID assigned to this event by your local FireFly node + */ + id?: string; + /** @description The namespace of the event. Your application must subscribe to events within a namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset + */ + reference?: string; + /** + * Format: int64 + * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) + */ + sequence?: number; + /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ + topic?: string; + /** + * Format: uuid + * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction + */ + tx?: string; + /** + * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application + * @enum {string} + */ + type?: "transaction_submitted" | "message_confirmed" | "message_rejected" | "datatype_confirmed" | "identity_confirmed" | "identity_updated" | "token_pool_confirmed" | "token_pool_op_failed" | "token_transfer_confirmed" | "token_transfer_op_failed" | "token_approval_confirmed" | "token_approval_op_failed" | "contract_interface_confirmed" | "contract_api_confirmed" | "blockchain_event_received" | "blockchain_invoke_op_succeeded" | "blockchain_invoke_op_failed" | "blockchain_contract_deploy_op_succeeded" | "blockchain_contract_deploy_op_failed"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenAccountsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The blockchain signing identity this balance applies to */ + key?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenAccountPoolsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pool?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The key for the token account. The exact format may vary based on the token connector use */ + key: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID the token pool this balance entry applies to + */ + pool?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenApprovalsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + active?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + approved?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + blockchainevent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + connector?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + localid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + messagehash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + operator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pool?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + protocolid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + subject?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ + active?: boolean; + /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ + approved?: boolean; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the token approval + */ + created?: string; + /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token approval, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the approval, which must match the namespace of the token pool */ + namespace?: string; + /** @description The blockchain identity that is granted the approval */ + operator?: string; + /** + * Format: uuid + * @description The UUID the token pool this approval applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ + subject?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenApprovalNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ + approved?: boolean; + /** @description Input only field, with token connector specific configuration of the approval. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description You can specify a message to correlate with the approval, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the approval */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description The blockchain identity that is granted the approval */ + operator?: string; + /** + * Format: uuid + * @description The UUID the token pool this approval applies to + */ + pool?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ + active?: boolean; + /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ + approved?: boolean; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the token approval + */ + created?: string; + /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token approval, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the approval, which must match the namespace of the token pool */ + namespace?: string; + /** @description The blockchain identity that is granted the approval */ + operator?: string; + /** + * Format: uuid + * @description The UUID the token pool this approval applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ + subject?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ + active?: boolean; + /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ + approved?: boolean; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the token approval + */ + created?: string; + /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token approval, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the approval, which must match the namespace of the token pool */ + namespace?: string; + /** @description The blockchain identity that is granted the approval */ + operator?: string; + /** + * Format: uuid + * @description The UUID the token pool this approval applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ + subject?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenBalancesNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + balance?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + connector?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pool?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tokenindex?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + uri?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The numeric balance. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when interpreting the balance. For example, with 18 decimals a fractional balance of 10.234 will be returned as 10,234,000,000,000,000,000 */ + balance?: string; + /** @description The token connector that is responsible for the token pool of this balance entry */ + connector?: string; + /** @description The blockchain signing identity this balance applies to */ + key?: string; + /** @description The namespace of the token pool for this balance entry */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this balance entry applies to + */ + pool?: string; + /** @description The index of the token within the pool that this balance applies to */ + tokenIndex?: string; + /** + * Format: date-time + * @description The last time the balance was updated by applying a transfer event + */ + updated?: string; + /** @description The URI of the token this balance entry applies to */ + uri?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenBurnNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description The name or UUID of a token pool */ + pool?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenConnectorsNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The name of the token connector, as configured in the FireFly core configuration file */ + name?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenMintNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description The name or UUID of a token pool */ + pool?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenPoolsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + active?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + connector?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + decimals?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interface?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interfaceformat?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + locator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + networkname?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + published?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + standard?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + symbol?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenPoolNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + /** @description When true the definition will be published to all other members of the multiparty network */ + publish?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Input only field, with token connector specific configuration of the pool, such as an existing Ethereum address and block number to used to index the pool. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenPoolByNameOrIDNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The token pool name or ID */ + nameOrId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteTokenPoolNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The token pool name or ID */ + nameOrId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenPoolPublishNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The token pool name or ID */ + nameOrId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenTransfersNamespace: { + parameters: { + query?: { + /** @description The sending or receiving token account for a token transfer */ + fromOrTo?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + amount?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + blockchainevent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + connector?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + from?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + localid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + messagehash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pool?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + protocolid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + to?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tokenindex?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + uri?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenTransferNamespace: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description The name or UUID of a token pool */ + pool?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenTransferByIDNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The token transfer ID */ + transferId: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnsNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + blockchainids?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ + blockchainIds?: string[]; + /** + * Format: date-time + * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction + */ + created?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ + idempotencyKey?: string; + /** @description The namespace of the FireFly transaction */ + namespace?: string; + /** + * @description The type of the FireFly transaction + * @enum {string} + */ + type?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnByIDNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + blockchainids?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The transaction ID */ + txnid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ + blockchainIds?: string[]; + /** + * Format: date-time + * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction + */ + created?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ + idempotencyKey?: string; + /** @description The namespace of the FireFly transaction */ + namespace?: string; + /** + * @description The type of the FireFly transaction + * @enum {string} + */ + type?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnBlockchainEventsNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The transaction ID */ + txnid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID assigned to the event by FireFly + */ + id?: string; + /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ + info?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace + */ + listener?: string; + /** @description The name of the event in the blockchain smart contract */ + name?: string; + /** @description The namespace of the listener that detected this blockchain event */ + namespace?: string; + /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ + output?: { + [key: string]: unknown; + }; + /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ + protocolId?: string; + /** @description The blockchain plugin or token service that detected the event */ + source?: string; + /** + * Format: date-time + * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors + */ + timestamp?: string; + /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ + tx?: { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ + blockchainId?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnOpsNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The transaction ID */ + txnid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnStatusNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The transaction ID */ + txnid: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A set of records describing the activities within the transaction known by the local FireFly node */ + details?: { + /** @description If an error occurred related to the detail entry, it is included here */ + error?: string; + /** + * Format: uuid + * @description The UUID of the entry referenced by this detail. The type of this record can be inferred from the entry type + */ + id?: string; + /** @description Output details for this entry */ + info?: { + [key: string]: unknown; + }; + /** @description The status of the detail record. Cases where an event is required for completion, but has not arrived yet are marked with a 'pending' record */ + status?: string; + /** @description A sub-type, such as an operation type, or an event type */ + subtype?: string; + /** + * Format: date-time + * @description The time relevant to when the record was updated, such as the time an event was created, or the last update time of an operation + */ + timestamp?: string; + /** @description The type of the transaction status detail record */ + type?: string; + }[]; + /** @description The overall computed status of the transaction, after analyzing the details during the API call */ + status?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getVerifiersNamespace: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + identity?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + value?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time this verifier was created on this node + */ + created?: string; + /** + * Format: byte + * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the parent identity that has claimed this verifier + */ + identity?: string; + /** @description The namespace of the verifier */ + namespace?: string; + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getVerifierByIDNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The hash of the verifier */ + hash: string; + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time this verifier was created on this node + */ + created?: string; + /** + * Format: byte + * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the parent identity that has claimed this verifier + */ + identity?: string; + /** @description The namespace of the verifier */ + namespace?: string; + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postVerifiersResolveNamespace: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The namespace which scopes this request */ + ns: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNetworkAction: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * @description The action to be performed + * @enum {string} + */ + type?: "terminate"; + }; + }; + }; + responses: { + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The action to be performed + * @enum {string} + */ + type?: "terminate"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkDIDDocByDID: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity DID */ + did: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description See https://www.w3.org/TR/did-core/#json-ld */ + "@context"?: string[]; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + authentication?: string[]; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + id?: string; + /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ + verificationMethod?: { + /** @description For blockchains like Ethereum that represent signing identities directly by their public key summarized in an account string */ + blockchainAcountId?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + controller?: string; + /** @description A string provided by your Data Exchange plugin, that it uses a technology specific mechanism to validate against when messages arrive from this identity */ + dataExchangePeerID?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + id?: string; + /** @description For Hyperledger Fabric where the signing identity is represented by an MSP identifier (containing X509 certificate DN strings) that were validated by your local MSP */ + mspIdentityString?: string; + /** @description See https://www.w3.org/TR/did-core/#service-properties */ + type?: string; + }[]; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkIdentities: { + parameters: { + query?: { + /** @description When set, the API will return the verifier for this identity */ + fetchverifiers?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + did?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.claim"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.update"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.verification"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + parent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + profile?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ + verifiers?: { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkIdentityByDID: { + parameters: { + query?: { + /** @description When set, the API will return the verifier for this identity */ + fetchverifiers?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The identity DID */ + did: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ + verifiers?: { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkNodes: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + did?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.claim"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.update"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.verification"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + parent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + profile?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkNode: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name or ID of the node */ + nameOrId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNodesSelf: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkOrgs: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + description?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + did?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.claim"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.update"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "messages.verification"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + parent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + profile?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewOrganization: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The blockchain signing key to use to make the claim to the identity. Must be available to the local node to sign the identity claim. Will become a verifier on the established identity */ + key?: string; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** @description The type of the identity */ + type?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNetworkOrg: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The name or ID of the org */ + nameOrId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewOrganizationSelf: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The creation time of the identity + */ + created?: string; + /** @description A description of the identity. Part of the updatable profile information of an identity */ + description?: string; + /** @description The DID of the identity. Unique across namespaces within a FireFly network */ + did?: string; + /** + * Format: uuid + * @description The UUID of the identity + */ + id?: string; + /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ + messages?: { + /** + * Format: uuid + * @description The UUID of claim message + */ + claim?: string; + /** + * Format: uuid + * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed + */ + update?: string; + /** + * Format: uuid + * @description The UUID of claim message. Unset for root organization identities + */ + verification?: string; + }; + /** @description The name of the identity. The name must be unique within the type and namespace */ + name?: string; + /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of the parent identity. Unset for root organization identities + */ + parent?: string; + /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ + profile?: { + [key: string]: unknown; + }; + /** + * @description The type of the identity + * @enum {string} + */ + type?: "org" | "node" | "custom"; + /** + * Format: date-time + * @description The last update time of the identity profile + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getNextPins: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + context?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + identity?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + nonce?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: byte + * @description The context the next-pin applies to - the hash of the privacy group-hash + topic. The group-hash is only known to the participants (can itself contain a salt in the group-name). This context is combined with the member and nonce to determine the final hash that is written on-chain + */ + context?: string; + /** + * Format: byte + * @description The unique masked pin string + */ + hash?: string; + /** @description The member of the privacy group the next-pin applies to */ + identity?: string; + /** @description The namespace of the next-pin */ + namespace?: string; + /** + * Format: int64 + * @description The numeric index - which is monotonically increasing for each member of the privacy group + */ + nonce?: number; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getOps: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + error?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + input?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + output?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + plugin?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + retry?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + status?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tx?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getOpByID: { + parameters: { + query?: { + /** @description When set, the API will return additional status information if available */ + fetchstatus?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The operation ID key to get */ + opid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Additional detailed information about an operation provided by the connector */ + detail?: unknown; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postOpRetry: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The UUID of the operation */ + opid: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: unknown; + }; + }; + }; + responses: { + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getPins: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + batch?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + dispatched?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + hash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + index?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + masked?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID of the batch of messages this pin is part of + */ + batch?: string; + /** + * Format: byte + * @description The manifest hash batch of messages this pin is part of + */ + batchHash?: string; + /** + * Format: date-time + * @description The time the FireFly node created the pin + */ + created?: string; + /** @description Once true, this pin has been processed and will not be processed again */ + dispatched?: boolean; + /** + * Format: byte + * @description The hash represents a topic within a message in the batch. If a message has multiple topics, then multiple pins are created. If the message is private, the hash is masked for privacy + */ + hash?: string; + /** + * Format: int64 + * @description The index of this pin within the batch. One pin is created for each topic, of each message in the batch + */ + index?: number; + /** @description True if the pin is for a private message, and hence is masked with the group ID and salted with a nonce so observers of the blockchain cannot use pin hash to match this transaction to other transactions or participants */ + masked?: boolean; + /** @description The namespace of the pin */ + namespace?: string; + /** + * Format: int64 + * @description The order of the pin in the local FireFly database, which matches the order in which pins were delivered to FireFly by the blockchain connector event stream + */ + sequence?: number; + /** @description The blockchain signing key that submitted this transaction, as passed through to FireFly by the smart contract that emitted the blockchain event */ + signer?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postPinsRewind: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * Format: uuid + * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified + */ + batch?: string; + /** + * Format: int64 + * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified + */ + sequence?: number; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified + */ + batch?: string; + /** + * Format: int64 + * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified + */ + sequence?: number; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getStatus: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Information about the multi-party system configured on this namespace */ + multiparty?: { + /** @description Information about the multi-party smart contract configured for this namespace */ + contract?: { + /** @description The currently active FireFly smart contract */ + active?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ + firstEvent?: string; + /** @description The index of this contract in the config file */ + index?: number; + /** @description Additional info about the current status of the multi-party contract */ + info?: { + /** @description The identifier for the final blockchain event received from this contract before termination */ + finalEvent?: string; + /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ + subscription?: string; + /** @description The version of this multiparty contract */ + version?: number; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }; + /** @description Previously-terminated FireFly smart contracts */ + terminated?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ + firstEvent?: string; + /** @description The index of this contract in the config file */ + index?: number; + /** @description Additional info about the current status of the multi-party contract */ + info?: { + /** @description The identifier for the final blockchain event received from this contract before termination */ + finalEvent?: string; + /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ + subscription?: string; + /** @description The version of this multiparty contract */ + version?: number; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + }; + /** @description Whether multi-party mode is enabled for this namespace */ + enabled?: boolean; + }; + /** @description The namespace that this status applies to */ + namespace?: { + /** + * Format: date-time + * @description The time the namespace was created + */ + created?: string; + /** @description A description of the namespace */ + description?: string; + /** @description The local namespace name */ + name?: string; + /** @description The shared namespace name within the multiparty network */ + networkName?: string; + }; + /** @description Details of the local node */ + node?: { + /** + * Format: uuid + * @description The UUID of the node, if registered + */ + id?: string; + /** @description The name of this node, as specified in the local configuration */ + name?: string; + /** @description Whether the node has been successfully registered */ + registered?: boolean; + }; + /** @description Details of the root organization identity registered for this namespace on the local node */ + org?: { + /** @description The DID of the organization identity, if registered */ + did?: string; + /** + * Format: uuid + * @description The UUID of the organization, if registered + */ + id?: string; + /** @description The name of the node operator organization, as specified in the local configuration */ + name?: string; + /** @description Whether the organization has been successfully registered */ + registered?: boolean; + /** @description Array of verifiers (blockchain keys) owned by this identity */ + verifiers?: { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }; + /** @description Information about plugins configured on this namespace */ + plugins?: { + /** @description The blockchain plugins on this namespace */ + blockchain?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The data exchange plugins on this namespace */ + dataExchange?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The database plugins on this namespace */ + database?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The event plugins on this namespace */ + events?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The identity plugins on this namespace */ + identity?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The shared storage plugins on this namespace */ + sharedStorage?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + /** @description The token plugins on this namespace */ + tokens?: { + /** @description The name of the plugin */ + name?: string; + /** @description The type of the plugin */ + pluginType?: string; + }[]; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getStatusBatchManager: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description An array of currently active batch processors */ + processors?: { + /** @description The type of dispatcher for this processor */ + dispatcher?: string; + /** @description The name of the processor, which includes details of the attributes of message are allocated to this processor */ + name?: string; + /** @description The flush status for this batch processor */ + status?: { + /** + * Format: int64 + * @description The average byte size of each batch + */ + averageBatchBytes?: number; + /** + * Format: double + * @description The average number of data attachments included in each batch + */ + averageBatchData?: number; + /** + * Format: double + * @description The average number of messages included in each batch + */ + averageBatchMessages?: number; + /** + * Format: int64 + * @description The average amount of time spent flushing each batch + */ + averageFlushTimeMS?: number; + /** @description True if the batch flush is in a retry loop, due to errors being returned by the plugins */ + blocked?: boolean; + /** @description True if the current batch flush has been cancelled */ + cancelled?: boolean; + /** + * Format: uuid + * @description If a flush is in progress, this is the UUID of the batch being flushed + */ + flushing?: string; + /** @description The last error received by this batch processor while flushing */ + lastFlushError?: string; + /** + * Format: date-time + * @description The time of the last flush + */ + lastFlushErrorTime?: string; + /** + * Format: date-time + * @description The last time a flush was performed + */ + lastFlushStartTime?: string; + /** + * Format: int64 + * @description The total count of batches flushed by this processor since it started + */ + totalBatches?: number; + /** + * Format: int64 + * @description The total count of error flushed encountered by this processor since it started + */ + totalErrors?: number; + }; + }[]; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getStatusMultiparty: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Information about the active and terminated multi-party smart contracts configured for this namespace */ + contracts?: { + /** @description The currently active FireFly smart contract */ + active?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ + firstEvent?: string; + /** @description The index of this contract in the config file */ + index?: number; + /** @description Additional info about the current status of the multi-party contract */ + info?: { + /** @description The identifier for the final blockchain event received from this contract before termination */ + finalEvent?: string; + /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ + subscription?: string; + /** @description The version of this multiparty contract */ + version?: number; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + /** @description The status of the contract listener. One of 'syncing', 'synced', or 'unknown' */ + status?: string; + }; + /** @description Previously-terminated FireFly smart contracts */ + terminated?: { + /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ + firstEvent?: string; + /** @description The index of this contract in the config file */ + index?: number; + /** @description Additional info about the current status of the multi-party contract */ + info?: { + /** @description The identifier for the final blockchain event received from this contract before termination */ + finalEvent?: string; + /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ + subscription?: string; + /** @description The version of this multiparty contract */ + version?: number; + }; + /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ + location?: unknown; + }[]; + }; + /** @description Whether multi-party mode is enabled for this namespace */ + enabled?: boolean; + /** @description Details of the local node */ + node?: { + /** + * Format: uuid + * @description The ID of the pending message that broadcast the identity claim to the network + */ + pendingRegistrationMessageId?: string; + /** @description The status of the node registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ + status?: string; + }; + /** @description Details of the root organization identity registered for this namespace on the local node */ + org?: { + /** + * Format: uuid + * @description The ID of the pending message that broadcast the identity claim to the network + */ + pendingRegistrationMessageId?: string; + /** @description The status of the organization registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ + status?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getSubscriptions: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + events?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + filters?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + options?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + transport?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description Creation time of the subscription + */ + created?: string; + /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ + ephemeral?: boolean; + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** + * Format: uuid + * @description The UUID of the subscription + */ + id?: string; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + /** + * Format: date-time + * @description Last time the subscription was updated + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + putSubscription: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description Creation time of the subscription + */ + created?: string; + /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ + ephemeral?: boolean; + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** + * Format: uuid + * @description The UUID of the subscription + */ + id?: string; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + /** + * Format: date-time + * @description Last time the subscription was updated + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postNewSubscription: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + }; + }; + }; + responses: { + /** @description Success */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description Creation time of the subscription + */ + created?: string; + /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ + ephemeral?: boolean; + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** + * Format: uuid + * @description The UUID of the subscription + */ + id?: string; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + /** + * Format: date-time + * @description Last time the subscription was updated + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getSubscriptionByID: { + parameters: { + query?: { + /** @description When set, the API will return additional status information if available */ + fetchstatus?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The subscription ID */ + subid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description Creation time of the subscription + */ + created?: string; + /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ + ephemeral?: boolean; + /** @description Server-side filter to apply to events */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** + * Format: uuid + * @description The UUID of the subscription + */ + id?: string; + /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ + name?: string; + /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ + namespace?: string; + /** @description Subscription options */ + options?: { + /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ + batch?: boolean; + /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ + batchTimeout?: string; + /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ + fastack?: boolean; + /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ + firstEvent?: string; + /** @description Webhooks only: Static headers to set on the webhook request */ + headers?: { + [key: string]: string; + }; + /** @description Webhooks only: a set of options for HTTP */ + httpOptions?: { + /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ + connectionTimeout?: string; + /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ + expectContinueTimeout?: string; + /** @description The max duration to hold a HTTP keepalive connection between calls */ + idleTimeout?: string; + /** @description The max number of idle connections to hold pooled */ + maxIdleConns?: number; + /** @description HTTP proxy URL to use for outbound requests to the webhook */ + proxyURL?: string; + /** @description The max duration to hold a TLS handshake alive */ + requestTimeout?: string; + /** @description The max duration to hold a TLS handshake alive */ + tlsHandshakeTimeout?: string; + }; + /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ + input?: { + /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ + body?: string; + /** @description A top-level property of the first data input, to use for headers */ + headers?: string; + /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ + path?: string; + /** @description A top-level property of the first data input, to use for query parameters */ + query?: string; + /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ + replytx?: string; + }; + /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ + json?: boolean; + /** @description Webhooks only: HTTP method to invoke. Default=POST */ + method?: string; + /** @description Webhooks only: Static query params to set on the webhook request */ + query?: { + [key: string]: string; + }; + /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ + readAhead?: number; + /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ + reply?: boolean; + /** @description Webhooks only: The tag to set on the reply message */ + replytag?: string; + /** @description Webhooks only: The transaction type to set on the reply message */ + replytx?: string; + /** @description Webhooks only: a set of options for retrying the webhook call */ + retry?: { + /** @description Number of times to retry the webhook call in case of failure */ + count?: number; + /** @description Enables retry on HTTP calls, defaults to false */ + enabled?: boolean; + /** @description Initial delay between retries when we retry the webhook call */ + initialDelay?: string; + /** @description Max delay between retries when we retry the webhookcall */ + maxDelay?: string; + }; + /** @description The name of an existing TLS configuration associated to the namespace to use */ + tlsConfigName?: string; + /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ + url?: string; + /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ + withData?: boolean; + }; + /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ + transport?: string; + /** + * Format: date-time + * @description Last time the subscription was updated + */ + updated?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteSubscription: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The subscription ID */ + subid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getSubscriptionEventsFiltered: { + parameters: { + query?: { + /** @description The sequence ID in the raw event stream to start indexing through events from. Leave blank to start indexing from the most recent events */ + startsequence?: string; + /** @description The sequence ID in the raw event stream to stop indexing through events at. Leave blank to start indexing from the most recent events */ + endsequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + correlator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + reference?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + sequence?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + topic?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tx?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The subscription ID */ + subid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool + */ + correlator?: string; + /** + * Format: date-time + * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications + */ + created?: string; + /** + * Format: uuid + * @description The UUID assigned to this event by your local FireFly node + */ + id?: string; + /** @description The namespace of the event. Your application must subscribe to events within a namespace */ + namespace?: string; + /** + * Format: uuid + * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset + */ + reference?: string; + /** + * Format: int64 + * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) + */ + sequence?: number; + /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ + topic?: string; + /** + * Format: uuid + * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction + */ + tx?: string; + /** + * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application + * @enum {string} + */ + type?: "transaction_submitted" | "message_confirmed" | "message_rejected" | "datatype_confirmed" | "identity_confirmed" | "identity_updated" | "token_pool_confirmed" | "token_pool_op_failed" | "token_transfer_confirmed" | "token_transfer_op_failed" | "token_approval_confirmed" | "token_approval_op_failed" | "contract_interface_confirmed" | "contract_api_confirmed" | "blockchain_event_received" | "blockchain_invoke_op_succeeded" | "blockchain_invoke_op_failed" | "blockchain_contract_deploy_op_succeeded" | "blockchain_contract_deploy_op_failed"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenAccounts: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The blockchain signing identity this balance applies to */ + key?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenAccountPools: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pool?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The key for the token account. The exact format may vary based on the token connector use */ + key: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID the token pool this balance entry applies to + */ + pool?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenApprovals: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + active?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + approved?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + blockchainevent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + connector?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + localid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + messagehash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + operator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pool?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + protocolid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + subject?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ + active?: boolean; + /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ + approved?: boolean; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the token approval + */ + created?: string; + /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token approval, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the approval, which must match the namespace of the token pool */ + namespace?: string; + /** @description The blockchain identity that is granted the approval */ + operator?: string; + /** + * Format: uuid + * @description The UUID the token pool this approval applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ + subject?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenApproval: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ + approved?: boolean; + /** @description Input only field, with token connector specific configuration of the approval. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description You can specify a message to correlate with the approval, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the approval */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description The blockchain identity that is granted the approval */ + operator?: string; + /** + * Format: uuid + * @description The UUID the token pool this approval applies to + */ + pool?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ + active?: boolean; + /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ + approved?: boolean; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the token approval + */ + created?: string; + /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token approval, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the approval, which must match the namespace of the token pool */ + namespace?: string; + /** @description The blockchain identity that is granted the approval */ + operator?: string; + /** + * Format: uuid + * @description The UUID the token pool this approval applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ + subject?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ + active?: boolean; + /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ + approved?: boolean; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the token approval + */ + created?: string; + /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token approval, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the approval, which must match the namespace of the token pool */ + namespace?: string; + /** @description The blockchain identity that is granted the approval */ + operator?: string; + /** + * Format: uuid + * @description The UUID the token pool this approval applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ + subject?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenBalances: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + balance?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + connector?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pool?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tokenindex?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + updated?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + uri?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The numeric balance. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when interpreting the balance. For example, with 18 decimals a fractional balance of 10.234 will be returned as 10,234,000,000,000,000,000 */ + balance?: string; + /** @description The token connector that is responsible for the token pool of this balance entry */ + connector?: string; + /** @description The blockchain signing identity this balance applies to */ + key?: string; + /** @description The namespace of the token pool for this balance entry */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this balance entry applies to + */ + pool?: string; + /** @description The index of the token within the pool that this balance applies to */ + tokenIndex?: string; + /** + * Format: date-time + * @description The last time the balance was updated by applying a transfer event + */ + updated?: string; + /** @description The URI of the token this balance entry applies to */ + uri?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenBurn: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description The name or UUID of a token pool */ + pool?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenConnectors: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The name of the token connector, as configured in the FireFly core configuration file */ + name?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenMint: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description The name or UUID of a token pool */ + pool?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenPools: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + active?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + connector?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + decimals?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + id?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interface?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + interfaceformat?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + locator?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + name?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + networkname?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + published?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + standard?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + symbol?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenPool: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + /** @description When true the definition will be published to all other members of the multiparty network */ + publish?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Input only field, with token connector specific configuration of the pool, such as an existing Ethereum address and block number to used to index the pool. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenPoolByNameOrID: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The token pool name or ID */ + nameOrId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + deleteTokenPool: { + parameters: { + query?: never; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The token pool name or ID */ + nameOrId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 204: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenPoolPublish: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; + header?: { + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The token pool name or ID */ + nameOrId: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ + networkName?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Indicates whether the pool has been successfully activated with the token connector */ + active?: boolean; + /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the pool + */ + created?: string; + /** @description Number of decimal places that this token has */ + decimals?: number; + /** + * Format: uuid + * @description The UUID of the token pool + */ + id?: string; + /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ + info?: { + [key: string]: unknown; + }; + /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ + interface?: { + /** + * Format: uuid + * @description The UUID of the FireFly interface + */ + id?: string; + /** @description The name of the FireFly interface */ + name?: string; + /** @description The version of the FireFly interface */ + version?: string; + }; + /** + * @description The interface encoding format supported by the connector for this token pool + * @enum {string} + */ + interfaceFormat?: "abi" | "ffi"; + /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ + key?: string; + /** @description A unique identifier for the pool, as provided by the token connector */ + locator?: string; + /** + * Format: uuid + * @description The UUID of the broadcast message used to inform the network about this pool + */ + message?: string; + /** @description The method definitions resolved by the token connector to be used by each token operation */ + methods?: unknown; + /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ + name?: string; + /** @description The namespace for the token pool */ + namespace?: string; + /** @description The published name of the token pool within the multiparty network */ + networkName?: string; + /** @description Indicates if the token pool is published to other members of the multiparty network */ + published?: boolean; + /** @description The ERC standard the token pool conforms to, as reported by the token connector */ + standard?: string; + /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ + symbol?: string; + /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of token the pool contains, such as fungible/non-fungible + * @enum {string} + */ + type?: "fungible" | "nonfungible"; + }; + }; }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ - method?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the method */ - name?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description The pathname of the method on the specified FFI */ - methodPath?: string; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets a list of contract listeners */ - getContractListenersNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - backendid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interface?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - location?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - signature?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topic?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a new blockchain listener for events emitted by custom smart contracts */ - postNewContractListenerNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ - eventPath?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - }; - /** Gets a contract listener by its name or ID */ - getContractListenerByNameOrIDNamespace: { - parameters: { - path: { - /** The contract listener name or ID */ - nameOrId: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return additional status information if available */ - fetchstatus?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An ID assigned by the blockchain connector to this listener */ - backendId?: string; - /** - * Format: date-time - * @description The creation time of the listener - */ - created?: string; - /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI */ - event?: { - /** @description A description of the smart contract event */ - description?: string; - /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the event */ - name?: string; - /** @description An array of event parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** - * Format: uuid - * @description The UUID of the smart contract listener - */ - id?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the event */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description A descriptive name for the listener */ - name?: string; - /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ - namespace?: string; - /** @description Options that control how the listener subscribes to events from the underlying blockchain */ - options?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ - firstEvent?: string; - }; - /** @description The stringified signature of the event, as computed by the blockchain plugin */ - signature?: string; - /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ - topic?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Deletes a contract listener referenced by its name or its ID */ - deleteContractListenerNamespace: { - parameters: { - path: { - /** The contract listener name or ID */ - nameOrId: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Queries a method on a smart contract. Performs a read-only query. */ - postContractQueryNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ - errors?: { - /** @description A description of the smart contract error */ - description?: string; - /** @description The name of the error */ - name?: string; - /** @description An array of error parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }[]; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface - */ - interface?: string; - /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenTransfers: { + parameters: { + query?: { + /** @description The sending or receiving token account for a token transfer */ + fromOrTo?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + amount?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + blockchainevent?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + connector?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + from?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + key?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + localid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + message?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + messagehash?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + pool?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + protocolid?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + to?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + tokenindex?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.id"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + "tx.type"?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + type?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + uri?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; }; - /** @description The message header contains all fields that are used to build the message hash */ header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ - method?: { - /** @description A description of the smart contract method */ - description?: string; - /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { [key: string]: any }; - /** @description The name of the method */ - name?: string; - /** @description An array of method parameter/argument definitions */ - params?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - /** @description An array of method return definitions */ - returns?: { - /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ - name?: string; - /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: any; - }[]; - }; - /** @description The pathname of the method on the specified FFI */ - methodPath?: string; - /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets a list of data items */ - getDataNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.hash"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.name"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.path"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.public"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "blob.size"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "datatype.name"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "datatype.version"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - public?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - validator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - value?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a new data item in this FireFly node */ - postDataNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 201: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }; - "multipart/form-data": { - /** @description Success */ - autometa?: string; - /** @description Success */ - "datatype.name"?: string; - /** @description Success */ - "datatype.version"?: string; - /** Format: binary */ - "filename.ext"?: string; - /** @description Success */ - metadata?: string; - /** @description Success */ - validator?: string; - }; - }; - }; - }; - /** Gets a data item by its ID, including metadata about this item */ - getDataByIDNamespace: { - parameters: { - path: { - /** The data item ID */ - dataid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }; - }; - }; - default: unknown; - }; - }; - /** Deletes a data item by its ID, including metadata about this item */ - deleteDataNamespace: { - parameters: { - path: { - /** The data item ID */ - dataid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Downloads the original file that was previously uploaded or received */ - getDataBlobNamespace: { - parameters: { - path: { - /** The data item ID */ - dataid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - cid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - datahash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pins?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - rejectreason?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tag?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topics?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txtype?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": string; - }; - }; - default: unknown; - }; - }; - /** Publishes the binary blob attachment stored in your local data exchange, to shared storage */ - postDataBlobPublishNamespace: { - parameters: { - path: { - /** The blob ID */ - dataid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Gets a list of the messages associated with a data item */ - getDataMsgsNamespace: { - parameters: { - path: { - /** The data item ID */ - dataid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - cid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - datahash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pins?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - rejectreason?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tag?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topics?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txtype?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + postTokenTransfer: { + parameters: { + query?: { + /** @description When true the HTTP request blocks until the message is confirmed */ + confirm?: string; + }; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Downloads the JSON value of the data resource, without the associated metadata */ - getDataValueNamespace: { - parameters: { - path: { - /** The blob ID */ - dataid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - cid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - datahash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pins?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - rejectreason?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tag?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topics?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txtype?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": string; - }; - }; - default: unknown; - }; - }; - /** Publishes the JSON value from the specified data resource, to shared storage */ - postDataValuePublishNamespace: { - parameters: { - path: { - /** The blob ID */ - dataid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Gets a list of path names of named blob data, underneath a given parent path ('/' path prefixes are automatically pre-prepended) */ - getDataSubPathsNamespace: { - parameters: { - path: { - /** The parent path to query */ - parent: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": string[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of datatypes that have been published */ - getDatatypesNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - validator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - version?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the datatype was created - */ - created?: string; - /** - * Format: byte - * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the datatype - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this datatype to the network - */ - message?: string; - /** @description The name of the datatype */ - name?: string; - /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ - namespace?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates and broadcasts a new datatype */ - postNewDatatypeNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the datatype was created - */ - created?: string; - /** - * Format: byte - * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the datatype - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this datatype to the network - */ - message?: string; - /** @description The name of the datatype */ - name?: string; - /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ - namespace?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the datatype was created - */ - created?: string; - /** - * Format: byte - * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the datatype - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this datatype to the network - */ - message?: string; - /** @description The name of the datatype */ - name?: string; - /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ - namespace?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the datatype */ - name?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }; - }; - }; - }; - /** Gets a datatype by its name and version */ - getDatatypeByNameNamespace: { - parameters: { - path: { - /** The name of the datatype */ - name: string; - /** The version of the datatype */ - version: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the datatype was created - */ - created?: string; - /** - * Format: byte - * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the datatype - */ - id?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message that was used to publish this datatype to the network - */ - message?: string; - /** @description The name of the datatype */ - name?: string; - /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ - namespace?: string; - /** - * @description The validator that should be used to verify this datatype - * @enum {string} - */ - validator?: "json" | "none" | "definition"; - /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: any; - /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ - version?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of events */ - getEventsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the record that this item references in its 'reference' field */ - fetchreferences?: string; - /** When set, the API will return the record that this item references in its 'reference' field */ - fetchreference?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - correlator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - reference?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topic?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tx?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool - */ - correlator?: string; - /** - * Format: date-time - * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications - */ - created?: string; - /** - * Format: uuid - * @description The UUID assigned to this event by your local FireFly node - */ - id?: string; - /** @description The namespace of the event. Your application must subscribe to events within a namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset - */ - reference?: string; - /** - * Format: int64 - * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) - */ - sequence?: number; - /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ - topic?: string; - /** - * Format: uuid - * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction - */ - tx?: string; - /** - * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application - * @enum {string} - */ - type?: - | "transaction_submitted" - | "message_confirmed" - | "message_rejected" - | "datatype_confirmed" - | "identity_confirmed" - | "identity_updated" - | "token_pool_confirmed" - | "token_pool_op_failed" - | "token_transfer_confirmed" - | "token_transfer_op_failed" - | "token_approval_confirmed" - | "token_approval_op_failed" - | "contract_interface_confirmed" - | "contract_api_confirmed" - | "blockchain_event_received" - | "blockchain_invoke_op_succeeded" - | "blockchain_invoke_op_failed" - | "blockchain_contract_deploy_op_succeeded" - | "blockchain_contract_deploy_op_failed"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets an event by its ID */ - getEventByIDNamespace: { - parameters: { - path: { - /** The event ID */ - eid: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the record that this item references in its 'reference' field */ - fetchreference?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool - */ - correlator?: string; - /** - * Format: date-time - * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications - */ - created?: string; - /** - * Format: uuid - * @description The UUID assigned to this event by your local FireFly node - */ - id?: string; - /** @description The namespace of the event. Your application must subscribe to events within a namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset - */ - reference?: string; - /** - * Format: int64 - * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) - */ - sequence?: number; - /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ - topic?: string; - /** - * Format: uuid - * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction - */ - tx?: string; - /** - * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application - * @enum {string} - */ - type?: - | "transaction_submitted" - | "message_confirmed" - | "message_rejected" - | "datatype_confirmed" - | "identity_confirmed" - | "identity_updated" - | "token_pool_confirmed" - | "token_pool_op_failed" - | "token_transfer_confirmed" - | "token_transfer_op_failed" - | "token_approval_confirmed" - | "token_approval_op_failed" - | "contract_interface_confirmed" - | "contract_api_confirmed" - | "blockchain_event_received" - | "blockchain_invoke_op_succeeded" - | "blockchain_invoke_op_failed" - | "blockchain_contract_deploy_op_succeeded" - | "blockchain_contract_deploy_op_failed"; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of groups */ - getGroupsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - ledger?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time when the group was first used to send a message in the network - */ - created?: string; - /** - * Format: byte - * @description The identifier hash of this group. Derived from the name and group members - */ - hash?: string; - /** @description The local namespace of the group */ - localNamespace?: string; - /** @description The list of members in this privacy group */ - members?: { - /** @description The DID of the group member */ - identity?: string; - /** - * Format: uuid - * @description The UUID of the node that receives a copy of the off-chain message for the identity - */ - node?: string; - }[]; - /** - * Format: uuid - * @description The message used to broadcast this group privately to the members - */ - message?: string; - /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ - name?: string; - /** @description The namespace of the group within the multiparty network */ - namespace?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a group by its ID (hash) */ - getGroupByHashNamespace: { - parameters: { - path: { - /** The hash of the group */ - hash: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time when the group was first used to send a message in the network - */ - created?: string; - /** - * Format: byte - * @description The identifier hash of this group. Derived from the name and group members - */ - hash?: string; - /** @description The local namespace of the group */ - localNamespace?: string; - /** @description The list of members in this privacy group */ - members?: { - /** @description The DID of the group member */ - identity?: string; - /** - * Format: uuid - * @description The UUID of the node that receives a copy of the off-chain message for the identity - */ - node?: string; - }[]; - /** - * Format: uuid - * @description The message used to broadcast this group privately to the members - */ - message?: string; - /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ - name?: string; - /** @description The namespace of the group within the multiparty network */ - namespace?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of all identities that have been registered in the namespace */ - getIdentitiesNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - did?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.claim"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.update"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.verification"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - parent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - profile?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }[]; - }; - }; - default: unknown; - }; - }; - /** Registers a new identity in the network */ - postNewIdentityNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The blockchain signing key to use to make the claim to the identity. Must be available to the local node to sign the identity claim. Will become a verifier on the established identity */ - key?: string; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** @description The type of the identity */ - type?: string; - }; - }; - }; - }; - /** Gets an identity by its DID */ - getIdentityByDIDNamespace: { - parameters: { - path: { - /** The identity DID */ - did: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets an identity by its ID */ - getIdentityByIDNamespace: { - parameters: { - path: { - /** The identity ID, which is a UUID generated by FireFly */ - iid: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Updates an identity */ - patchUpdateIdentityNamespace: { - parameters: { - path: { - /** The identity ID, which is a UUID generated by FireFly */ - iid: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - }; - }; - }; - }; - /** Gets the DID for an identity based on its ID */ - getIdentityDIDNamespace: { - parameters: { - path: { - /** The identity ID, which is a UUID generated by FireFly */ - iid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description See https://www.w3.org/TR/did-core/#json-ld */ - "@context"?: string[]; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - authentication?: string[]; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - id?: string; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - verificationMethod?: { - /** @description For blockchains like Ethereum that represent signing identities directly by their public key summarized in an account string */ - blockchainAcountId?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - controller?: string; - /** @description A string provided by your Data Exchange plugin, that it uses a technology specific mechanism to validate against when messages arrive from this identity */ - dataExchangePeerID?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - id?: string; - /** @description For Hyperledger Fabric where the signing identity is represented by an MSP identifier (containing X509 certificate DN strings) that were validated by your local MSP */ - mspIdentityString?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - type?: string; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets the verifiers for an identity */ - getIdentityVerifiersNamespace: { - parameters: { - path: { - /** The identity ID, which is a UUID generated by FireFly */ - iid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - identity?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - value?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time this verifier was created on this node - */ - created?: string; - /** - * Format: byte - * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the parent identity that has claimed this verifier - */ - identity?: string; - /** @description The namespace of the verifier */ - namespace?: string; - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of messages */ - getMsgsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** Fetch the data and include it in the messages returned */ - fetchdata?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - author?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - cid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - confirmed?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - datahash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - group?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pins?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - rejectreason?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - state?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tag?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topics?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "txparent.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - txtype?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ + config?: { + [key: string]: unknown; + }; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ + idempotencyKey?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ + message?: { + /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ + data?: { + /** @description The optional datatype to use for validation of the in-line data */ + datatype?: { + /** @description The name of the datatype */ + name?: string; + /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ + version?: string; + }; + /** + * Format: uuid + * @description The UUID of the referenced data resource + */ + id?: string; + /** @description The data validator type to use for in-line data */ + validator?: string; + /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ + value?: unknown; + }[]; + /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ + group?: { + /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ + members?: { + /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + identity?: string; + /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ + node?: string; + }[]; + /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ + name?: string; + }; + /** @description The message header contains all fields that are used to build the message hash */ + header?: { + /** @description The DID of identity of the submitter */ + author?: string; + /** + * Format: uuid + * @description The correlation ID of the message. Set this when a message is a response to another message + */ + cid?: string; + /** + * Format: byte + * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group + */ + group?: string; + /** @description The on-chain signing key used to sign the transaction */ + key?: string; + /** @description The message tag indicates the purpose of the message to the applications that process it */ + tag?: string; + /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ + topics?: string[]; + /** + * @description The type of transaction used to order/deliver this message + * @enum {string} + */ + txtype?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + /** + * @description The type of the message + * @enum {string} + */ + type?: "definition" | "broadcast" | "private" | "groupinit" | "transfer_broadcast" | "transfer_private" | "approval_broadcast" | "approval_private"; + }; + /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ + idempotencyKey?: string; + }; + /** @description The name or UUID of a token pool */ + pool?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + /** @description Success */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTokenTransferByID: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The token transfer ID */ + transferId: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ + amount?: string; + /** + * Format: uuid + * @description The UUID of the blockchain event + */ + blockchainEvent?: string; + /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ + connector?: string; + /** + * Format: date-time + * @description The creation time of the transfer + */ + created?: string; + /** @description The source account for the transfer. On input defaults to the value of 'key' */ + from?: string; + /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ + key?: string; + /** + * Format: uuid + * @description The UUID of this token transfer, in the local FireFly node + */ + localId?: string; + /** + * Format: uuid + * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + message?: string; + /** + * Format: byte + * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector + */ + messageHash?: string; + /** @description The namespace for the transfer, which must match the namespace of the token pool */ + namespace?: string; + /** + * Format: uuid + * @description The UUID the token pool this transfer applies to + */ + pool?: string; + /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ + protocolId?: string; + /** @description The target account for the transfer. On input defaults to the value of 'key' */ + to?: string; + /** @description The index of the token within the pool that this transfer applies to */ + tokenIndex?: string; + /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ + tx?: { + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + /** + * @description The type of transfer such as mint/burn/transfer + * @enum {string} + */ + type?: "mint" | "burn" | "transfer"; + /** @description The URI of the token this transfer applies to */ + uri?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxns: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + blockchainids?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ id?: string; - /** @description The type of the FireFly transaction */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a message by its ID */ - getMsgByIDNamespace: { - parameters: { - path: { - /** The message ID */ - msgid: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** Fetch the data and include it in the messages returned */ - fetchdata?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description An optional in-line hash reference to a previously uploaded binary data blob */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ + blockchainIds?: string[]; + /** + * Format: date-time + * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction + */ + created?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ + idempotencyKey?: string; + /** @description The namespace of the FireFly transaction */ + namespace?: string; + /** + * @description The type of the FireFly transaction + * @enum {string} + */ + type?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnByID: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + blockchainids?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ id?: string; - /** @description The type of the FireFly transaction */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + idempotencykey?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets the list of data items that are attached to a message */ - getMsgDataNamespace: { - parameters: { - path: { - /** The message ID */ - msgid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An optional hash reference to a binary blob attachment */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ - hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** - * Format: date-time - * @description The creation time of the data resource - */ - created?: string; - /** @description The optional datatype to use of validation of this data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the data resource - */ - id?: string; - /** @description The namespace of the data resource */ - namespace?: string; - /** @description If the JSON value has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** @description The data validator type */ - validator?: string; - /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: any; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets the list of events for a message */ - getMsgEventsNamespace: { - parameters: { - path: { - /** The message ID */ - msgid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - correlator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - reference?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - topic?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tx?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool - */ - correlator?: string; - /** - * Format: date-time - * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications - */ - created?: string; - /** - * Format: uuid - * @description The UUID assigned to this event by your local FireFly node - */ - id?: string; - /** @description The namespace of the event. Your application must subscribe to events within a namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset - */ - reference?: string; - /** - * Format: int64 - * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) - */ - sequence?: number; - /** @description A stream of information this event relates to. For message confirmation events, a separate event is emitted for each topic in the message. For blockchain events, the listener specifies the topic. Rules exist for how the topic is set for other event types */ - topic?: string; - /** - * Format: uuid - * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction - */ - tx?: string; - /** - * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application - * @enum {string} - */ - type?: - | "transaction_submitted" - | "message_confirmed" - | "message_rejected" - | "datatype_confirmed" - | "identity_confirmed" - | "identity_updated" - | "token_pool_confirmed" - | "token_pool_op_failed" - | "token_transfer_confirmed" - | "token_transfer_op_failed" - | "token_approval_confirmed" - | "token_approval_op_failed" - | "contract_interface_confirmed" - | "contract_api_confirmed" - | "blockchain_event_received" - | "blockchain_invoke_op_succeeded" - | "blockchain_invoke_op_failed" - | "blockchain_contract_deploy_op_succeeded" - | "blockchain_contract_deploy_op_failed"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets the transaction for a message */ - getMsgTxnNamespace: { - parameters: { - path: { - /** The message ID */ - msgid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ - blockchainIds?: string[]; - /** - * Format: date-time - * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction - */ - created?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ - idempotencyKey?: string; - /** @description The namespace of the FireFly transaction */ - namespace?: string; - /** - * @description The type of the FireFly transaction - * @enum {string} - */ - type?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - }; - }; - }; - default: unknown; - }; - }; - /** Broadcasts a message to all members in the network */ - postNewMessageBroadcastNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; + }; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The transaction ID */ + txnid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ + blockchainIds?: string[]; + /** + * Format: date-time + * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction + */ + created?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ + idempotencyKey?: string; + /** @description The namespace of the FireFly transaction */ + namespace?: string; + /** + * @description The type of the FireFly transaction + * @enum {string} + */ + type?: "none" | "unpinned" | "batch_pin" | "network_action" | "token_pool" | "token_transfer" | "contract_deploy" | "contract_invoke" | "contract_invoke_pin" | "token_approval" | "data_publish"; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnBlockchainEvents: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Privately sends a message to one or more members in the network */ - postNewMessagePrivateNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The transaction ID */ + txnid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: uuid + * @description The UUID assigned to the event by FireFly + */ + id?: string; + /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ + info?: { + [key: string]: unknown; + }; + /** + * Format: uuid + * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace + */ + listener?: string; + /** @description The name of the event in the blockchain smart contract */ + name?: string; + /** @description The namespace of the listener that detected this blockchain event */ + namespace?: string; + /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ + output?: { + [key: string]: unknown; + }; + /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ + protocolId?: string; + /** @description The blockchain plugin or token service that detected the event */ + source?: string; + /** + * Format: date-time + * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors + */ + timestamp?: string; + /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ + tx?: { + /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ + blockchainId?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction + */ + id?: string; + /** @description The type of the FireFly transaction */ + type?: string; + }; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnOps: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description The list of data elements attached to the message */ - data?: { - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - }[]; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The transaction ID */ + txnid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time the operation was created + */ + created?: string; + /** @description Any error reported back from the plugin for this operation */ + error?: string; + /** + * Format: uuid + * @description The UUID of the operation + */ + id?: string; + /** @description The input to this operation */ + input?: { + [key: string]: unknown; + }; + /** @description The namespace of the operation */ + namespace?: string; + /** @description Any output reported back from the plugin for this operation */ + output?: { + [key: string]: unknown; + }; + /** @description The plugin responsible for performing the operation */ + plugin?: string; + /** + * Format: uuid + * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried + */ + retry?: string; + /** @description The current status of the operation */ + status?: string; + /** + * Format: uuid + * @description The UUID of the FireFly transaction the operation is part of + */ + tx?: string; + /** + * @description The type of the operation + * @enum {string} + */ + type?: "blockchain_pin_batch" | "blockchain_network_action" | "blockchain_deploy" | "blockchain_invoke" | "sharedstorage_upload_batch" | "sharedstorage_upload_blob" | "sharedstorage_upload_value" | "sharedstorage_download_batch" | "sharedstorage_download_blob" | "dataexchange_send_batch" | "dataexchange_send_blob" | "token_create_pool" | "token_activate_pool" | "token_transfer" | "token_approval"; + /** + * Format: date-time + * @description The last update time of the operation + */ + updated?: string; + }[]; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getTxnStatus: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Sends a message with a blocking HTTP request, waits for a reply to that message, then sends the reply as the HTTP response. */ - postNewMessageRequestReplyNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch in which the message was pinned/transferred - */ - batch?: string; - /** - * Format: date-time - * @description The timestamp of when the message was confirmed/rejected - */ - confirmed?: string; - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description An optional in-line hash reference to a previously uploaded binary data blob */ - blob?: { - /** - * Format: byte - * @description The hash of the binary blob data - */ + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path: { + /** @description The transaction ID */ + txnid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description A set of records describing the activities within the transaction known by the local FireFly node */ + details?: { + /** @description If an error occurred related to the detail entry, it is included here */ + error?: string; + /** + * Format: uuid + * @description The UUID of the entry referenced by this detail. The type of this record can be inferred from the entry type + */ + id?: string; + /** @description Output details for this entry */ + info?: { + [key: string]: unknown; + }; + /** @description The status of the detail record. Cases where an event is required for completion, but has not arrived yet are marked with a 'pending' record */ + status?: string; + /** @description A sub-type, such as an operation type, or an event type */ + subtype?: string; + /** + * Format: date-time + * @description The time relevant to when the record was updated, such as the time an event was created, or the last update time of an operation + */ + timestamp?: string; + /** @description The type of the transaction status detail record */ + type?: string; + }[]; + /** @description The overall computed status of the transaction, after analyzing the details during the API call */ + status?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + getVerifiers: { + parameters: { + query?: { + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ + created?: string; + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ hash?: string; - /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ - name?: string; - /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ - path?: string; - /** @description If the blob data has been published to shared storage, this field is the id of the data in the shared storage plugin (IPFS hash etc.) */ - public?: string; - /** - * Format: int64 - * @description The size of the binary data - */ - size?: number; - }; - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: byte - * @description The hash of the referenced data - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** - * Format: byte - * @description The hash of the message. Derived from the header, which includes the data hash - */ - hash?: string; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: date-time - * @description The creation time of the message - */ - created?: string; - /** - * Format: byte - * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message - */ - datahash?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** - * Format: uuid - * @description The UUID of the message. Unique to each message - */ - id?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The namespace of the message within the multiparty network */ - namespace?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** @description The parent transaction that originally triggered this message */ - txparent?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ type?: string; - }; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - /** @description The local namespace of the message */ - localNamespace?: string; - /** @description For private messages, a unique pin hash:nonce is assigned for each topic */ - pins?: string[]; - /** @description If a message was rejected, provides details on the rejection reason */ - rejectReason?: string; - /** - * @description The current state of the message - * @enum {string} - */ - state?: - | "staged" - | "ready" - | "sent" - | "pending" - | "confirmed" - | "rejected"; - /** - * Format: uuid - * @description The ID of the transaction used to order/deliver this message - */ - txid?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; - }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - }; - }; - }; - /** Notify all nodes in the network of a new governance action */ - postNetworkActionNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 202: { - content: { - "application/json": { - /** - * @description The action to be performed - * @enum {string} - */ - type?: "terminate"; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The action to be performed - * @enum {string} - */ - type?: "terminate"; - }; - }; - }; - }; - /** Gets a DID document by its DID */ - getNetworkDIDDocByDIDNamespace: { - parameters: { - path: { - /** The identity DID */ - did: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description See https://www.w3.org/TR/did-core/#json-ld */ - "@context"?: string[]; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - authentication?: string[]; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - id?: string; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - verificationMethod?: { - /** @description For blockchains like Ethereum that represent signing identities directly by their public key summarized in an account string */ - blockchainAcountId?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - controller?: string; - /** @description A string provided by your Data Exchange plugin, that it uses a technology specific mechanism to validate against when messages arrive from this identity */ - dataExchangePeerID?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - id?: string; - /** @description For Hyperledger Fabric where the signing identity is represented by an MSP identifier (containing X509 certificate DN strings) that were validated by your local MSP */ - mspIdentityString?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - type?: string; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets the list of identities in the network (deprecated - use /identities instead of /network/identities */ - getNetworkIdentitiesNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - did?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.claim"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.update"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.verification"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - parent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - profile?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets an identity by its DID */ - getNetworkIdentityByDIDNamespace: { - parameters: { - path: { - /** The identity DID */ - did: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of nodes in the network */ - getNetworkNodesNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - did?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.claim"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.update"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.verification"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - parent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - profile?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets information about a specific node in the network */ - getNetworkNodeNamespace: { - parameters: { - path: { - /** The name or ID of the node */ - nameOrId: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Instructs this FireFly node to register itself on the network */ - postNodesSelfNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - /** Gets a list of orgs in the network */ - getNetworkOrgsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - did?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.claim"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.update"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.verification"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - parent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - profile?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Registers a new org in the network */ - postNewOrganizationNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The blockchain signing key to use to make the claim to the identity. Must be available to the local node to sign the identity claim. Will become a verifier on the established identity */ - key?: string; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** @description The type of the identity */ - type?: string; - }; - }; - }; - }; - /** Gets information about a specific org in the network */ - getNetworkOrgNamespace: { - parameters: { - path: { - /** The name or ID of the org */ - nameOrId: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Instructs this FireFly node to register its org on the network */ - postNewOrganizationSelfNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - /** Queries the list of next-pins that determine the next masked message sequence for each member of a privacy group, on each context/topic */ - getNextPinsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - context?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - identity?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - nonce?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: byte - * @description The context the next-pin applies to - the hash of the privacy group-hash + topic. The group-hash is only known to the participants (can itself contain a salt in the group-name). This context is combined with the member and nonce to determine the final hash that is written on-chain - */ - context?: string; - /** - * Format: byte - * @description The unique masked pin string - */ - hash?: string; - /** @description The member of the privacy group the next-pin applies to */ - identity?: string; - /** @description The namespace of the next-pin */ - namespace?: string; - /** - * Format: int64 - * @description The numeric index - which is monotonically increasing for each member of the privacy group - */ - nonce?: number; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a a list of operations */ - getOpsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - error?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - input?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - output?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - plugin?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - retry?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - status?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tx?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets an operation by ID */ - getOpByIDNamespace: { - parameters: { - path: { - /** The operation ID key to get */ - opid: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return additional status information if available */ - fetchstatus?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Additional detailed information about an operation provided by the connector */ - detail?: any; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Retries a failed operation */ - postOpRetryNamespace: { - parameters: { - path: { - /** The UUID of the operation */ - opid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - /** Queries the list of pins received from the blockchain */ - getPinsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - dispatched?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - index?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - masked?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch of messages this pin is part of - */ - batch?: string; - /** - * Format: byte - * @description The manifest hash batch of messages this pin is part of - */ - batchHash?: string; - /** - * Format: date-time - * @description The time the FireFly node created the pin - */ - created?: string; - /** @description Once true, this pin has been processed and will not be processed again */ - dispatched?: boolean; - /** - * Format: byte - * @description The hash represents a topic within a message in the batch. If a message has multiple topics, then multiple pins are created. If the message is private, the hash is masked for privacy - */ - hash?: string; - /** - * Format: int64 - * @description The index of this pin within the batch. One pin is created for each topic, of each message in the batch - */ - index?: number; - /** @description True if the pin is for a private message, and hence is masked with the group ID and salted with a nonce so observers of the blockchain cannot use pin hash to match this transaction to other transactions or participants */ - masked?: boolean; - /** @description The namespace of the pin */ - namespace?: string; - /** - * Format: int64 - * @description The order of the pin in the local FireFly database, which matches the order in which pins were delivered to FireFly by the blockchain connector event stream - */ - sequence?: number; - /** @description The blockchain signing key that submitted this transaction, as passed through to FireFly by the smart contract that emitted the blockchain event */ - signer?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Force a rewind of the event aggregator to a previous position, to re-evaluate (and possibly dispatch) that pin and others after it. Only accepts a sequence or batch ID for a currently undispatched pin */ - postPinsRewindNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified - */ - batch?: string; - /** - * Format: int64 - * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified - */ - sequence?: number; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** - * Format: uuid - * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified - */ - batch?: string; - /** - * Format: int64 - * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified - */ - sequence?: number; - }; - }; - }; - }; - /** Gets the status of this namespace */ - getStatusNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Information about the multi-party system configured on this namespace */ - multiparty?: { - /** @description Information about the multi-party smart contract configured for this namespace */ - contract?: { - /** @description The currently active FireFly smart contract */ - active?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ - firstEvent?: string; - /** @description The index of this contract in the config file */ - index?: number; - /** @description Additional info about the current status of the multi-party contract */ - info?: { - /** @description The identifier for the final blockchain event received from this contract before termination */ - finalEvent?: string; - /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ - subscription?: string; - /** @description The version of this multiparty contract */ - version?: number; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - }; - /** @description Previously-terminated FireFly smart contracts */ - terminated?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ - firstEvent?: string; - /** @description The index of this contract in the config file */ - index?: number; - /** @description Additional info about the current status of the multi-party contract */ - info?: { - /** @description The identifier for the final blockchain event received from this contract before termination */ - finalEvent?: string; - /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ - subscription?: string; - /** @description The version of this multiparty contract */ - version?: number; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - }[]; - }; - /** @description Whether multi-party mode is enabled for this namespace */ - enabled?: boolean; - }; - /** @description The namespace that this status applies to */ - namespace?: { - /** - * Format: date-time - * @description The time the namespace was created - */ - created?: string; - /** @description A description of the namespace */ - description?: string; - /** @description The local namespace name */ - name?: string; - /** @description The shared namespace name within the multiparty network */ - networkName?: string; - }; - /** @description Details of the local node */ - node?: { - /** - * Format: uuid - * @description The UUID of the node, if registered - */ - id?: string; - /** @description The name of this node, as specified in the local configuration */ - name?: string; - /** @description Whether the node has been successfully registered */ - registered?: boolean; - }; - /** @description Details of the root organization identity registered for this namespace on the local node */ - org?: { - /** @description The DID of the organization identity, if registered */ - did?: string; - /** - * Format: uuid - * @description The UUID of the organization, if registered - */ - id?: string; - /** @description The name of the node operator organization, as specified in the local configuration */ - name?: string; - /** @description Whether the organization has been successfully registered */ - registered?: boolean; - /** @description Array of verifiers (blockchain keys) owned by this identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + /** @description Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ value?: string; - }[]; - }; - /** @description Information about plugins configured on this namespace */ - plugins?: { - /** @description The blockchain plugins on this namespace */ - blockchain?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The data exchange plugins on this namespace */ - dataExchange?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The database plugins on this namespace */ - database?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The event plugins on this namespace */ - events?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The identity plugins on this namespace */ - identity?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The shared storage plugins on this namespace */ - sharedStorage?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The token plugins on this namespace */ - tokens?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - }; - }; - }; - }; - default: unknown; - }; - }; - /** Gets the status of the batch manager */ - getStatusBatchManagerNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An array of currently active batch processors */ - processors?: { - /** @description The type of dispatcher for this processor */ - dispatcher?: string; - /** @description The name of the processor, which includes details of the attributes of message are allocated to this processor */ - name?: string; - /** @description The flush status for this batch processor */ - status?: { - /** - * Format: int64 - * @description The average byte size of each batch - */ - averageBatchBytes?: number; - /** - * Format: double - * @description The average number of data attachments included in each batch - */ - averageBatchData?: number; - /** - * Format: double - * @description The average number of messages included in each batch - */ - averageBatchMessages?: number; - /** - * Format: int64 - * @description The average amount of time spent flushing each batch - */ - averageFlushTimeMS?: number; - /** @description True if the batch flush is in a retry loop, due to errors being returned by the plugins */ - blocked?: boolean; - /** - * Format: uuid - * @description If a flush is in progress, this is the UUID of the batch being flushed - */ - flushing?: string; - /** @description The last error received by this batch processor while flushing */ - lastFlushError?: string; - /** - * Format: date-time - * @description The time of the last flush - */ - lastFlushErrorTime?: string; - /** - * Format: date-time - * @description The last time a flush was performed - */ - lastFlushStartTime?: string; - /** - * Format: int64 - * @description The total count of batches flushed by this processor since it started - */ - totalBatches?: number; - /** - * Format: int64 - * @description The total count of error flushed encountered by this processor since it started - */ - totalErrors?: number; - }; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of subscriptions */ - getSubscriptionsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - events?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - filters?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - options?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - transport?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description Creation time of the subscription - */ - created?: string; - /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ - ephemeral?: boolean; - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** - * Format: uuid - * @description The UUID of the subscription - */ - id?: string; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - /** - * Format: date-time - * @description Last time the subscription was updated - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Update an existing subscription */ - putSubscriptionNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description Creation time of the subscription - */ - created?: string; - /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ - ephemeral?: boolean; - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** - * Format: uuid - * @description The UUID of the subscription - */ - id?: string; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - /** - * Format: date-time - * @description Last time the subscription was updated - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - }; - }; - }; - }; - /** Creates a new subscription for an application to receive events from FireFly */ - postNewSubscriptionNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 201: { - content: { - "application/json": { - /** - * Format: date-time - * @description Creation time of the subscription - */ - created?: string; - /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ - ephemeral?: boolean; - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** - * Format: uuid - * @description The UUID of the subscription - */ - id?: string; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - /** - * Format: date-time - * @description Last time the subscription was updated - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - }; - }; - }; - }; - /** Gets a subscription by its ID */ - getSubscriptionByIDNamespace: { - parameters: { - path: { - /** The subscription ID */ - subid: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When set, the API will return additional status information if available */ - fetchstatus?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description Creation time of the subscription - */ - created?: string; - /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ - ephemeral?: boolean; - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** - * Format: uuid - * @description The UUID of the subscription - */ - id?: string; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - /** - * Format: date-time - * @description Last time the subscription was updated - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Deletes a subscription */ - deleteSubscriptionNamespace: { - parameters: { - path: { - /** The subscription ID */ - subid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Gets a list of token accounts */ - getTokenAccountsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The blockchain signing identity this balance applies to */ - key?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of token pools that contain a given token account key */ - getTokenAccountPoolsNamespace: { - parameters: { - path: { - /** The key for the token account. The exact format may vary based on the token connector use */ - key: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pool?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID the token pool this balance entry applies to - */ - pool?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of token approvals */ - getTokenApprovalsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - active?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - approved?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - blockchainevent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - connector?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - localid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - messagehash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - operator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pool?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - protocolid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - subject?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ - active?: boolean; - /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ - approved?: boolean; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the token approval - */ - created?: string; - /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token approval, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the approval, which must match the namespace of the token pool */ - namespace?: string; - /** @description The blockchain identity that is granted the approval */ - operator?: string; - /** - * Format: uuid - * @description The UUID the token pool this approval applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ - subject?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a token approval */ - postTokenApprovalNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ - active?: boolean; - /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ - approved?: boolean; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the token approval - */ - created?: string; - /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token approval, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the approval, which must match the namespace of the token pool */ - namespace?: string; - /** @description The blockchain identity that is granted the approval */ - operator?: string; - /** - * Format: uuid - * @description The UUID the token pool this approval applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ - subject?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ - active?: boolean; - /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ - approved?: boolean; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the token approval - */ - created?: string; - /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token approval, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the approval, which must match the namespace of the token pool */ - namespace?: string; - /** @description The blockchain identity that is granted the approval */ - operator?: string; - /** - * Format: uuid - * @description The UUID the token pool this approval applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ - subject?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ - approved?: boolean; - /** @description Input only field, with token connector specific configuration of the approval. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description You can specify a message to correlate with the approval, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the approval */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ + sort?: string; + /** @description Ascending sort order (overrides all fields in a multi-field sort) */ + ascending?: string; + /** @description Descending sort order (overrides all fields in a multi-field sort) */ + descending?: string; + /** @description The number of records to skip (max: 1,000). Unsuitable for bulk operations */ + skip?: string; + /** @description The maximum number of records to return (max: 1,000) */ + limit?: string; + /** @description Return a total count as well as items (adds extra database processing) */ + count?: string; }; - /** @description The message header contains all fields that are used to build the message hash */ header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description The blockchain identity that is granted the approval */ - operator?: string; - /** - * Format: uuid - * @description The UUID the token pool this approval applies to - */ - pool?: string; - }; - }; - }; - }; - /** Gets a list of token balances */ - getTokenBalancesNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - balance?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - connector?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pool?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tokenindex?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - uri?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The numeric balance. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when interpreting the balance. For example, with 18 decimals a fractional balance of 10.234 will be returned as 10,234,000,000,000,000,000 */ - balance?: string; - /** @description The token connector that is responsible for the token pool of this balance entry */ - connector?: string; - /** @description The blockchain signing identity this balance applies to */ - key?: string; - /** @description The namespace of the token pool for this balance entry */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this balance entry applies to - */ - pool?: string; - /** @description The index of the token within the pool that this balance applies to */ - tokenIndex?: string; - /** - * Format: date-time - * @description The last time the balance was updated by applying a transfer event - */ - updated?: string; - /** @description The URI of the token this balance entry applies to */ - uri?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Burns some tokens */ - postTokenBurnNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time this verifier was created on this node + */ + created?: string; + /** + * Format: byte + * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the parent identity that has claimed this verifier + */ + identity?: string; + /** @description The namespace of the verifier */ + namespace?: string; + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }[]; + }; }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description The name or UUID of a token pool */ - pool?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - }; - /** Gets the list of token connectors currently in use */ - getTokenConnectorsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The name of the token connector, as configured in the FireFly core configuration file */ - name?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Mints some tokens */ - postTokenMintNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; }; - /** @description The message header contains all fields that are used to build the message hash */ + }; + }; + getVerifierByID: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description The name or UUID of a token pool */ - pool?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - }; - /** Gets a list of token pools */ - getTokenPoolsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - active?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - connector?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - decimals?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interface?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interfaceformat?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - locator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - networkname?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - published?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - standard?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - symbol?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a new token pool */ - postTokenPoolNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - /** When true the definition will be published to all other members of the multiparty network */ - publish?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Input only field, with token connector specific configuration of the pool, such as an existing Ethereum address and block number to used to index the pool. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - }; - /** Gets a token pool by its name or its ID */ - getTokenPoolByNameOrIDNamespace: { - parameters: { - path: { - /** The token pool name or ID */ - nameOrId: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - default: unknown; - }; - }; - /** Delete a token pool */ - deleteTokenPoolNamespace: { - parameters: { - path: { - /** The token pool name or ID */ - nameOrId: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Publish a token pool to all other members of the multiparty network */ - postTokenPoolPublishNamespace: { - parameters: { - path: { - /** The token pool name or ID */ - nameOrId: string; - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ - networkName?: string; - }; - }; - }; - }; - /** Gets a list of token transfers */ - getTokenTransfersNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** The sending or receiving token account for a token transfer */ - fromOrTo?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - amount?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - blockchainevent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - connector?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - from?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - localid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - messagehash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pool?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - protocolid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - to?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tokenindex?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - uri?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Transfers some tokens */ - postTokenTransferNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description The name or UUID of a token pool */ - pool?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - }; - /** Gets a token transfer by its ID */ - getTokenTransferByIDNamespace: { - parameters: { - path: { - /** The token transfer ID */ - transferId: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of transactions */ - getTxnsNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - blockchainids?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ - blockchainIds?: string[]; - /** - * Format: date-time - * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction - */ - created?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ - idempotencyKey?: string; - /** @description The namespace of the FireFly transaction */ - namespace?: string; - /** - * @description The type of the FireFly transaction - * @enum {string} - */ - type?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a transaction by its ID */ - getTxnByIDNamespace: { - parameters: { - path: { - /** The transaction ID */ - txnid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - blockchainids?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ - blockchainIds?: string[]; - /** - * Format: date-time - * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction - */ - created?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ - idempotencyKey?: string; - /** @description The namespace of the FireFly transaction */ - namespace?: string; - /** - * @description The type of the FireFly transaction - * @enum {string} - */ - type?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list blockchain events for a specific transaction */ - getTxnBlockchainEventsNamespace: { - parameters: { - path: { - /** The transaction ID */ - txnid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID assigned to the event by FireFly - */ - id?: string; - /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace - */ - listener?: string; - /** @description The name of the event in the blockchain smart contract */ - name?: string; - /** @description The namespace of the listener that detected this blockchain event */ - namespace?: string; - /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { [key: string]: any }; - /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ - protocolId?: string; - /** @description The blockchain plugin or token service that detected the event */ - source?: string; - /** - * Format: date-time - * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors - */ - timestamp?: string; - /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ - tx?: { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ - blockchainId?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of operations in a specific transaction */ - getTxnOpsNamespace: { - parameters: { - path: { - /** The transaction ID */ - txnid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets the status of a transaction */ - getTxnStatusNamespace: { - parameters: { - path: { - /** The transaction ID */ - txnid: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A set of records describing the activities within the transaction known by the local FireFly node */ - details?: { - /** @description If an error occurred related to the detail entry, it is included here */ - error?: string; - /** - * Format: uuid - * @description The UUID of the entry referenced by this detail. The type of this record can be inferred from the entry type - */ - id?: string; - /** @description Output details for this entry */ - info?: { [key: string]: any }; - /** @description The status of the detail record. Cases where an event is required for completion, but has not arrived yet are marked with a 'pending' record */ - status?: string; - /** @description A sub-type, such as an operation type, or an event type */ - subtype?: string; - /** - * Format: date-time - * @description The time relevant to when the record was updated, such as the time an event was created, or the last update time of an operation - */ - timestamp?: string; - /** @description The type of the transaction status detail record */ - type?: string; - }[]; - /** @description The overall computed status of the transaction, after analyzing the details during the API call */ - status?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of verifiers */ - getVerifiersNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - identity?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - value?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time this verifier was created on this node - */ - created?: string; - /** - * Format: byte - * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the parent identity that has claimed this verifier - */ - identity?: string; - /** @description The namespace of the verifier */ - namespace?: string; - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a verifier by its hash */ - getVerifierByIDNamespace: { - parameters: { - path: { - /** The hash of the verifier */ - hash: string; - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time this verifier was created on this node - */ - created?: string; - /** - * Format: byte - * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the parent identity that has claimed this verifier - */ - identity?: string; - /** @description The namespace of the verifier */ - namespace?: string; - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Resolves an input key to a signing key */ - postVerifiersResolveNamespace: { - parameters: { - path: { - /** The namespace which scopes this request */ - ns: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }; - }; - }; - }; - /** Notify all nodes in the network of a new governance action */ - postNetworkAction: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 202: { - content: { - "application/json": { - /** - * @description The action to be performed - * @enum {string} - */ - type?: "terminate"; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The action to be performed - * @enum {string} - */ - type?: "terminate"; - }; - }; - }; - }; - /** Gets a DID document by its DID */ - getNetworkDIDDocByDID: { - parameters: { - path: { - /** The identity DID */ - did: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description See https://www.w3.org/TR/did-core/#json-ld */ - "@context"?: string[]; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - authentication?: string[]; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - id?: string; - /** @description See https://www.w3.org/TR/did-core/#did-document-properties */ - verificationMethod?: { - /** @description For blockchains like Ethereum that represent signing identities directly by their public key summarized in an account string */ - blockchainAcountId?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - controller?: string; - /** @description A string provided by your Data Exchange plugin, that it uses a technology specific mechanism to validate against when messages arrive from this identity */ - dataExchangePeerID?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - id?: string; - /** @description For Hyperledger Fabric where the signing identity is represented by an MSP identifier (containing X509 certificate DN strings) that were validated by your local MSP */ - mspIdentityString?: string; - /** @description See https://www.w3.org/TR/did-core/#service-properties */ - type?: string; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets the list of identities in the network (deprecated - use /identities instead of /network/identities */ - getNetworkIdentities: { - parameters: { - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - did?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.claim"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.update"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.verification"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - parent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - profile?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets an identity by its DID */ - getNetworkIdentityByDID: { - parameters: { - path: { - /** The identity DID */ - did: string; - }; - query: { - /** When set, the API will return the verifier for this identity */ - fetchverifiers?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of nodes in the network */ - getNetworkNodes: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - did?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.claim"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.update"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.verification"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - parent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - profile?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets information about a specific node in the network */ - getNetworkNode: { - parameters: { - path: { - /** The name or ID of the node */ - nameOrId: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Instructs this FireFly node to register itself on the network */ - postNodesSelf: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - /** Gets a list of orgs in the network */ - getNetworkOrgs: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - description?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - did?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.claim"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.update"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "messages.verification"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - parent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - profile?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Registers a new org in the network */ - postNewOrganization: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The blockchain signing key to use to make the claim to the identity. Must be available to the local node to sign the identity claim. Will become a verifier on the established identity */ - key?: string; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** @description The type of the identity */ - type?: string; - }; - }; - }; - }; - /** Gets information about a specific org in the network */ - getNetworkOrg: { - parameters: { - path: { - /** The name or ID of the org */ - nameOrId: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Instructs this FireFly node to register its org on the network */ - postNewOrganizationSelf: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The creation time of the identity - */ - created?: string; - /** @description A description of the identity. Part of the updatable profile information of an identity */ - description?: string; - /** @description The DID of the identity. Unique across namespaces within a FireFly network */ - did?: string; - /** - * Format: uuid - * @description The UUID of the identity - */ - id?: string; - /** @description References to the broadcast messages that established this identity and proved ownership of the associated verifiers (keys) */ - messages?: { - /** - * Format: uuid - * @description The UUID of claim message - */ - claim?: string; - /** - * Format: uuid - * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed - */ - update?: string; - /** - * Format: uuid - * @description The UUID of claim message. Unset for root organization identities - */ - verification?: string; - }; - /** @description The name of the identity. The name must be unique within the type and namespace */ - name?: string; - /** @description The namespace of the identity. Organization and node identities are always defined in the ff_system namespace */ - namespace?: string; - /** - * Format: uuid - * @description The UUID of the parent identity. Unset for root organization identities - */ - parent?: string; - /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { [key: string]: any }; - /** - * @description The type of the identity - * @enum {string} - */ - type?: "org" | "node" | "custom"; - /** - * Format: date-time - * @description The last update time of the identity profile - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - /** Queries the list of next-pins that determine the next masked message sequence for each member of a privacy group, on each context/topic */ - getNextPins: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - context?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - identity?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - nonce?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: byte - * @description The context the next-pin applies to - the hash of the privacy group-hash + topic. The group-hash is only known to the participants (can itself contain a salt in the group-name). This context is combined with the member and nonce to determine the final hash that is written on-chain - */ - context?: string; - /** - * Format: byte - * @description The unique masked pin string - */ - hash?: string; - /** @description The member of the privacy group the next-pin applies to */ - identity?: string; - /** @description The namespace of the next-pin */ - namespace?: string; - /** - * Format: int64 - * @description The numeric index - which is monotonically increasing for each member of the privacy group - */ - nonce?: number; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a a list of operations */ - getOps: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - error?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - input?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - output?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - plugin?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - retry?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - status?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tx?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets an operation by ID */ - getOpByID: { - parameters: { - path: { - /** The operation ID key to get */ - opid: string; - }; - query: { - /** When set, the API will return additional status information if available */ - fetchstatus?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Additional detailed information about an operation provided by the connector */ - detail?: any; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Retries a failed operation */ - postOpRetry: { - parameters: { - path: { - /** The UUID of the operation */ - opid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 202: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { [key: string]: unknown }; - }; - }; - }; - /** Queries the list of pins received from the blockchain */ - getPins: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - batch?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - dispatched?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - index?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - masked?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - sequence?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID of the batch of messages this pin is part of - */ - batch?: string; - /** - * Format: byte - * @description The manifest hash batch of messages this pin is part of - */ - batchHash?: string; - /** - * Format: date-time - * @description The time the FireFly node created the pin - */ - created?: string; - /** @description Once true, this pin has been processed and will not be processed again */ - dispatched?: boolean; - /** - * Format: byte - * @description The hash represents a topic within a message in the batch. If a message has multiple topics, then multiple pins are created. If the message is private, the hash is masked for privacy - */ - hash?: string; - /** - * Format: int64 - * @description The index of this pin within the batch. One pin is created for each topic, of each message in the batch - */ - index?: number; - /** @description True if the pin is for a private message, and hence is masked with the group ID and salted with a nonce so observers of the blockchain cannot use pin hash to match this transaction to other transactions or participants */ - masked?: boolean; - /** @description The namespace of the pin */ - namespace?: string; - /** - * Format: int64 - * @description The order of the pin in the local FireFly database, which matches the order in which pins were delivered to FireFly by the blockchain connector event stream - */ - sequence?: number; - /** @description The blockchain signing key that submitted this transaction, as passed through to FireFly by the smart contract that emitted the blockchain event */ - signer?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Force a rewind of the event aggregator to a previous position, to re-evaluate (and possibly dispatch) that pin and others after it. Only accepts a sequence or batch ID for a currently undispatched pin */ - postPinsRewind: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified - */ - batch?: string; - /** - * Format: int64 - * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified - */ - sequence?: number; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** - * Format: uuid - * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified - */ - batch?: string; - /** - * Format: int64 - * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified - */ - sequence?: number; - }; - }; - }; - }; - /** Gets the status of this namespace */ - getStatus: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Information about the multi-party system configured on this namespace */ - multiparty?: { - /** @description Information about the multi-party smart contract configured for this namespace */ - contract?: { - /** @description The currently active FireFly smart contract */ - active?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ - firstEvent?: string; - /** @description The index of this contract in the config file */ - index?: number; - /** @description Additional info about the current status of the multi-party contract */ - info?: { - /** @description The identifier for the final blockchain event received from this contract before termination */ - finalEvent?: string; - /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ - subscription?: string; - /** @description The version of this multiparty contract */ - version?: number; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - }; - /** @description Previously-terminated FireFly smart contracts */ - terminated?: { - /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ - firstEvent?: string; - /** @description The index of this contract in the config file */ - index?: number; - /** @description Additional info about the current status of the multi-party contract */ - info?: { - /** @description The identifier for the final blockchain event received from this contract before termination */ - finalEvent?: string; - /** @description The backend identifier of the subscription for the FireFly BatchPin contract */ - subscription?: string; - /** @description The version of this multiparty contract */ - version?: number; - }; - /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: any; - }[]; - }; - /** @description Whether multi-party mode is enabled for this namespace */ - enabled?: boolean; - }; - /** @description The namespace that this status applies to */ - namespace?: { - /** - * Format: date-time - * @description The time the namespace was created - */ - created?: string; - /** @description A description of the namespace */ - description?: string; - /** @description The local namespace name */ - name?: string; - /** @description The shared namespace name within the multiparty network */ - networkName?: string; - }; - /** @description Details of the local node */ - node?: { - /** - * Format: uuid - * @description The UUID of the node, if registered - */ - id?: string; - /** @description The name of this node, as specified in the local configuration */ - name?: string; - /** @description Whether the node has been successfully registered */ - registered?: boolean; - }; - /** @description Details of the root organization identity registered for this namespace on the local node */ - org?: { - /** @description The DID of the organization identity, if registered */ - did?: string; - /** - * Format: uuid - * @description The UUID of the organization, if registered - */ - id?: string; - /** @description The name of the node operator organization, as specified in the local configuration */ - name?: string; - /** @description Whether the organization has been successfully registered */ - registered?: boolean; - /** @description Array of verifiers (blockchain keys) owned by this identity */ - verifiers?: { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; + path: { + /** @description The hash of the verifier */ + hash: string; }; - /** @description Information about plugins configured on this namespace */ - plugins?: { - /** @description The blockchain plugins on this namespace */ - blockchain?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The data exchange plugins on this namespace */ - dataExchange?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The database plugins on this namespace */ - database?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The event plugins on this namespace */ - events?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The identity plugins on this namespace */ - identity?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The shared storage plugins on this namespace */ - sharedStorage?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - /** @description The token plugins on this namespace */ - tokens?: { - /** @description The name of the plugin */ - name?: string; - /** @description The type of the plugin */ - pluginType?: string; - }[]; - }; - }; - }; - }; - default: unknown; - }; - }; - /** Gets the status of the batch manager */ - getStatusBatchManager: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description An array of currently active batch processors */ - processors?: { - /** @description The type of dispatcher for this processor */ - dispatcher?: string; - /** @description The name of the processor, which includes details of the attributes of message are allocated to this processor */ - name?: string; - /** @description The flush status for this batch processor */ - status?: { - /** - * Format: int64 - * @description The average byte size of each batch - */ - averageBatchBytes?: number; - /** - * Format: double - * @description The average number of data attachments included in each batch - */ - averageBatchData?: number; - /** - * Format: double - * @description The average number of messages included in each batch - */ - averageBatchMessages?: number; - /** - * Format: int64 - * @description The average amount of time spent flushing each batch - */ - averageFlushTimeMS?: number; - /** @description True if the batch flush is in a retry loop, due to errors being returned by the plugins */ - blocked?: boolean; - /** - * Format: uuid - * @description If a flush is in progress, this is the UUID of the batch being flushed - */ - flushing?: string; - /** @description The last error received by this batch processor while flushing */ - lastFlushError?: string; - /** - * Format: date-time - * @description The time of the last flush - */ - lastFlushErrorTime?: string; - /** - * Format: date-time - * @description The last time a flush was performed - */ - lastFlushStartTime?: string; - /** - * Format: int64 - * @description The total count of batches flushed by this processor since it started - */ - totalBatches?: number; - /** - * Format: int64 - * @description The total count of error flushed encountered by this processor since it started - */ - totalErrors?: number; - }; - }[]; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of subscriptions */ - getSubscriptions: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - events?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - filters?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - options?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - transport?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description Creation time of the subscription - */ - created?: string; - /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ - ephemeral?: boolean; - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** - * Format: uuid - * @description The UUID of the subscription - */ - id?: string; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - /** - * Format: date-time - * @description Last time the subscription was updated - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Update an existing subscription */ - putSubscription: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description Creation time of the subscription - */ - created?: string; - /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ - ephemeral?: boolean; - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** - * Format: uuid - * @description The UUID of the subscription - */ - id?: string; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - /** - * Format: date-time - * @description Last time the subscription was updated - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - }; - }; - }; - }; - /** Creates a new subscription for an application to receive events from FireFly */ - postNewSubscription: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 201: { - content: { - "application/json": { - /** - * Format: date-time - * @description Creation time of the subscription - */ - created?: string; - /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ - ephemeral?: boolean; - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** - * Format: uuid - * @description The UUID of the subscription - */ - id?: string; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - /** - * Format: date-time - * @description Last time the subscription was updated - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - }; - }; - }; - }; - /** Gets a subscription by its ID */ - getSubscriptionByID: { - parameters: { - path: { - /** The subscription ID */ - subid: string; - }; - query: { - /** When set, the API will return additional status information if available */ - fetchstatus?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description Creation time of the subscription - */ - created?: string; - /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ - ephemeral?: boolean; - /** @description Server-side filter to apply to events */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; - }; - /** - * Format: uuid - * @description The UUID of the subscription - */ - id?: string; - /** @description The name of the subscription. The application specifies this name when it connects, in order to attach to the subscription and receive events that arrived while it was disconnected. If multiple apps connect to the same subscription, events are workload balanced across the connected application instances */ - name?: string; - /** @description The namespace of the subscription. A subscription will only receive events generated in the namespace of the subscription */ - namespace?: string; - /** @description Subscription options */ - options?: { - /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. */ - batch?: boolean; - /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; - /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ - fastack?: boolean; - /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; - /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { [key: string]: string }; - /** @description Webhooks only: a set of options for HTTP */ - httpOptions?: { - /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ - connectionTimeout?: string; - /** @description See [ExpectContinueTimeout in the Go docs](https://pkg.go.dev/net/http#Transport) */ - expectContinueTimeout?: string; - /** @description The max duration to hold a HTTP keepalive connection between calls */ - idleTimeout?: string; - /** @description The max number of idle connections to hold pooled */ - maxIdleConns?: number; - /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; - /** @description The max duration to hold a TLS handshake alive */ - requestTimeout?: string; - /** @description The max duration to hold a TLS handshake alive */ - tlsHandshakeTimeout?: string; - }; - /** @description Webhooks only: A set of options to extract data from the first JSON input data in the incoming message. Only applies if withData=true */ - input?: { - /** @description A top-level property of the first data input, to use for the request body. Default is the whole first body */ - body?: string; - /** @description A top-level property of the first data input, to use for headers */ - headers?: string; - /** @description A top-level property of the first data input, to use for a path to append with escaping to the webhook path */ - path?: string; - /** @description A top-level property of the first data input, to use for query parameters */ - query?: string; - /** @description A top-level property of the first data input, to use to dynamically set whether to pin the response (so the requester can choose) */ - replytx?: string; - }; - /** @description Webhooks only: Whether to assume the response body is JSON, regardless of the returned Content-Type */ - json?: boolean; - /** @description Webhooks only: HTTP method to invoke. Default=POST */ - method?: string; - /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { [key: string]: string }; - /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; - /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ - reply?: boolean; - /** @description Webhooks only: The tag to set on the reply message */ - replytag?: string; - /** @description Webhooks only: The transaction type to set on the reply message */ - replytx?: string; - /** @description Webhooks only: a set of options for retrying the webhook call */ - retry?: { - /** @description Number of times to retry the webhook call in case of failure */ - count?: number; - /** @description Enables retry on HTTP calls, defaults to false */ - enabled?: boolean; - /** @description Initial delay between retries when we retry the webhook call */ - initialDelay?: string; - /** @description Max delay between retries when we retry the webhookcall */ - maxDelay?: string; - }; - /** @description The name of an existing TLS configuration associated to the namespace to use */ - tlsConfigName?: string; - /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ - url?: string; - /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; - }; - /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ - transport?: string; - /** - * Format: date-time - * @description Last time the subscription was updated - */ - updated?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Deletes a subscription */ - deleteSubscription: { - parameters: { - path: { - /** The subscription ID */ - subid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Gets a list of token accounts */ - getTokenAccounts: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The blockchain signing identity this balance applies to */ - key?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of token pools that contain a given token account key */ - getTokenAccountPools: { - parameters: { - path: { - /** The key for the token account. The exact format may vary based on the token connector use */ - key: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pool?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID the token pool this balance entry applies to - */ - pool?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of token approvals */ - getTokenApprovals: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - active?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - approved?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - blockchainevent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - connector?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - localid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - messagehash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - operator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pool?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - protocolid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - subject?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ - active?: boolean; - /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ - approved?: boolean; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the token approval - */ - created?: string; - /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token approval, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the approval, which must match the namespace of the token pool */ - namespace?: string; - /** @description The blockchain identity that is granted the approval */ - operator?: string; - /** - * Format: uuid - * @description The UUID the token pool this approval applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ - subject?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a token approval */ - postTokenApproval: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ - active?: boolean; - /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ - approved?: boolean; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the token approval - */ - created?: string; - /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token approval, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the approval, which must match the namespace of the token pool */ - namespace?: string; - /** @description The blockchain identity that is granted the approval */ - operator?: string; - /** - * Format: uuid - * @description The UUID the token pool this approval applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ - subject?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description Indicates if this approval is currently active (only one approval can be active per subject) */ - active?: boolean; - /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ - approved?: boolean; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the token approval - */ - created?: string; - /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token approval, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the approval, which must match the namespace of the token pool */ - namespace?: string; - /** @description The blockchain identity that is granted the approval */ - operator?: string; - /** - * Format: uuid - * @description The UUID the token pool this approval applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ - subject?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ - approved?: boolean; - /** @description Input only field, with token connector specific configuration of the approval. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description You can specify a message to correlate with the approval, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the approval */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * Format: date-time + * @description The time this verifier was created on this node + */ + created?: string; + /** + * Format: byte + * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network + */ + hash?: string; + /** + * Format: uuid + * @description The UUID of the parent identity that has claimed this verifier + */ + identity?: string; + /** @description The namespace of the verifier */ + namespace?: string; + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }; + }; }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description The blockchain identity that is granted the approval */ - operator?: string; - /** - * Format: uuid - * @description The UUID the token pool this approval applies to - */ - pool?: string; - }; - }; - }; - }; - /** Gets a list of token balances */ - getTokenBalances: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - balance?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - connector?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pool?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tokenindex?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - updated?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - uri?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The numeric balance. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when interpreting the balance. For example, with 18 decimals a fractional balance of 10.234 will be returned as 10,234,000,000,000,000,000 */ - balance?: string; - /** @description The token connector that is responsible for the token pool of this balance entry */ - connector?: string; - /** @description The blockchain signing identity this balance applies to */ - key?: string; - /** @description The namespace of the token pool for this balance entry */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this balance entry applies to - */ - pool?: string; - /** @description The index of the token within the pool that this balance applies to */ - tokenIndex?: string; - /** - * Format: date-time - * @description The last time the balance was updated by applying a transfer event - */ - updated?: string; - /** @description The URI of the token this balance entry applies to */ - uri?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Burns some tokens */ - postTokenBurn: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; }; - /** @description The message header contains all fields that are used to build the message hash */ + }; + }; + postVerifiersResolve: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description The name or UUID of a token pool */ - pool?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - }; - /** Gets the list of token connectors currently in use */ - getTokenConnectors: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The name of the token connector, as configured in the FireFly core configuration file */ - name?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Mints some tokens */ - postTokenMint: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }; }; - /** @description The message header contains all fields that are used to build the message hash */ - header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description The name or UUID of a token pool */ - pool?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - }; - /** Gets a list of token pools */ - getTokenPools: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - active?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - connector?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - decimals?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interface?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - interfaceformat?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - locator?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - name?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - networkname?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - published?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - standard?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - symbol?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Creates a new token pool */ - postTokenPool: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - /** When true the definition will be published to all other members of the multiparty network */ - publish?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description Input only field, with token connector specific configuration of the pool, such as an existing Ethereum address and block number to used to index the pool. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - }; - /** Gets a token pool by its name or its ID */ - getTokenPoolByNameOrID: { - parameters: { - path: { - /** The token pool name or ID */ - nameOrId: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - default: unknown; - }; - }; - /** Delete a token pool */ - deleteTokenPool: { - parameters: { - path: { - /** The token pool name or ID */ - nameOrId: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 204: { - content: { - "application/json": unknown; - }; - }; - default: unknown; - }; - }; - /** Publish a token pool to all other members of the multiparty network */ - postTokenPoolPublish: { - parameters: { - path: { - /** The token pool name or ID */ - nameOrId: string; - }; - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description Indicates whether the pool has been successfully activated with the token connector */ - active?: boolean; - /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the pool - */ - created?: string; - /** @description Number of decimal places that this token has */ - decimals?: number; - /** - * Format: uuid - * @description The UUID of the token pool - */ - id?: string; - /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { [key: string]: any }; - /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ - interface?: { - /** - * Format: uuid - * @description The UUID of the FireFly interface - */ - id?: string; - /** @description The name of the FireFly interface */ - name?: string; - /** @description The version of the FireFly interface */ - version?: string; - }; - /** - * @description The interface encoding format supported by the connector for this token pool - * @enum {string} - */ - interfaceFormat?: "abi" | "ffi"; - /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ - key?: string; - /** @description A unique identifier for the pool, as provided by the token connector */ - locator?: string; - /** - * Format: uuid - * @description The UUID of the broadcast message used to inform the network about this pool - */ - message?: string; - /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: any; - /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ - name?: string; - /** @description The namespace for the token pool */ - namespace?: string; - /** @description The published name of the token pool within the multiparty network */ - networkName?: string; - /** @description Indicates if the token pool is published to other members of the multiparty network */ - published?: boolean; - /** @description The ERC standard the token pool conforms to, as reported by the token connector */ - standard?: string; - /** @description The token symbol. If supplied on input for an existing on-chain token, this must match the on-chain information */ - symbol?: string; - /** @description Reference to the FireFly transaction used to create and broadcast this pool to the network */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of token the pool contains, such as fungible/non-fungible - * @enum {string} - */ - type?: "fungible" | "nonfungible"; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ - networkName?: string; - }; - }; - }; - }; - /** Gets a list of token transfers */ - getTokenTransfers: { - parameters: { - query: { - /** The sending or receiving token account for a token transfer */ - fromOrTo?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - amount?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - blockchainevent?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - connector?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - from?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - key?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - localid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - message?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - messagehash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - pool?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - protocolid?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - to?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - tokenindex?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.id"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - "tx.type"?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - uri?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Transfers some tokens */ - postTokenTransfer: { - parameters: { - query: { - /** When true the HTTP request blocks until the message is confirmed */ - confirm?: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - /** Success */ - 202: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { [key: string]: any }; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ - idempotencyKey?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** @description You can specify a message to correlate with the transfer, which can be of type broadcast or private. Your chosen token connector and on-chain smart contract must support on-chain/off-chain correlation by taking a `data` input on the transfer */ - message?: { - /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ - data?: { - /** @description The optional datatype to use for validation of the in-line data */ - datatype?: { - /** @description The name of the datatype */ - name?: string; - /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ - version?: string; - }; - /** - * Format: uuid - * @description The UUID of the referenced data resource - */ - id?: string; - /** @description The data validator type to use for in-line data */ - validator?: string; - /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: any; - }[]; - /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ - group?: { - /** @description An array of members of the group. If no identities local to the sending node are included, then the organization owner of the local node is added automatically */ - members?: { - /** @description The DID of the group member. On input can be a UUID or org name, and will be resolved to a DID */ - identity?: string; - /** @description The UUID of the node that will receive a copy of the off-chain message for the identity. The first applicable node for the identity will be picked automatically on input if not specified */ - node?: string; - }[]; - /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ - name?: string; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The type of the verifier + * @enum {string} + */ + type?: "ethereum_address" | "tezos_address" | "fabric_msp_id" | "dx_peer_id"; + /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ + value?: string; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; }; - /** @description The message header contains all fields that are used to build the message hash */ + }; + }; + getWebSockets: { + parameters: { + query?: never; header?: { - /** @description The DID of identity of the submitter */ - author?: string; - /** - * Format: uuid - * @description The correlation ID of the message. Set this when a message is a response to another message - */ - cid?: string; - /** - * Format: byte - * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group - */ - group?: string; - /** @description The on-chain signing key used to sign the transaction */ - key?: string; - /** @description The message tag indicates the purpose of the message to the applications that process it */ - tag?: string; - /** @description A message topic associates this message with an ordered stream of data. A custom topic should be assigned - using the default topic is discouraged */ - topics?: string[]; - /** - * @description The type of transaction used to order/deliver this message - * @enum {string} - */ - txtype?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - /** - * @description The type of the message - * @enum {string} - */ - type?: - | "definition" - | "broadcast" - | "private" - | "groupinit" - | "transfer_broadcast" - | "transfer_private" - | "approval_broadcast" - | "approval_private"; - }; - /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ - idempotencyKey?: string; - }; - /** @description The name or UUID of a token pool */ - pool?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - }; - /** Gets a token transfer by its ID */ - getTokenTransferByID: { - parameters: { - path: { - /** The token transfer ID */ - transferId: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ - amount?: string; - /** - * Format: uuid - * @description The UUID of the blockchain event - */ - blockchainEvent?: string; - /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ - connector?: string; - /** - * Format: date-time - * @description The creation time of the transfer - */ - created?: string; - /** @description The source account for the transfer. On input defaults to the value of 'key' */ - from?: string; - /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ - key?: string; - /** - * Format: uuid - * @description The UUID of this token transfer, in the local FireFly node - */ - localId?: string; - /** - * Format: uuid - * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - message?: string; - /** - * Format: byte - * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector - */ - messageHash?: string; - /** @description The namespace for the transfer, which must match the namespace of the token pool */ - namespace?: string; - /** - * Format: uuid - * @description The UUID the token pool this transfer applies to - */ - pool?: string; - /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ - protocolId?: string; - /** @description The target account for the transfer. On input defaults to the value of 'key' */ - to?: string; - /** @description The index of the token within the pool that this transfer applies to */ - tokenIndex?: string; - /** @description If submitted via FireFly, this will reference the UUID of the FireFly transaction (if the token connector in use supports attaching data) */ - tx?: { - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - /** - * @description The type of transfer such as mint/burn/transfer - * @enum {string} - */ - type?: "mint" | "burn" | "transfer"; - /** @description The URI of the token this transfer applies to */ - uri?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of transactions */ - getTxns: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - blockchainids?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ - blockchainIds?: string[]; - /** - * Format: date-time - * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction - */ - created?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ - idempotencyKey?: string; - /** @description The namespace of the FireFly transaction */ - namespace?: string; - /** - * @description The type of the FireFly transaction - * @enum {string} - */ - type?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a transaction by its ID */ - getTxnByID: { - parameters: { - path: { - /** The transaction ID */ - txnid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - blockchainids?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - id?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - idempotencykey?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain. FireFly transactions are extensible to support multiple blockchain transactions */ - blockchainIds?: string[]; - /** - * Format: date-time - * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction - */ - created?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description An optional unique identifier for a transaction. Cannot be duplicated within a namespace, thus allowing idempotent submission of transactions to the API */ - idempotencyKey?: string; - /** @description The namespace of the FireFly transaction */ - namespace?: string; - /** - * @description The type of the FireFly transaction - * @enum {string} - */ - type?: - | "none" - | "unpinned" - | "batch_pin" - | "network_action" - | "token_pool" - | "token_transfer" - | "contract_deploy" - | "contract_invoke" - | "contract_invoke_pin" - | "token_approval" - | "data_publish"; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list blockchain events for a specific transaction */ - getTxnBlockchainEvents: { - parameters: { - path: { - /** The transaction ID */ - txnid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: uuid - * @description The UUID assigned to the event by FireFly - */ - id?: string; - /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { [key: string]: any }; - /** - * Format: uuid - * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace - */ - listener?: string; - /** @description The name of the event in the blockchain smart contract */ - name?: string; - /** @description The namespace of the listener that detected this blockchain event */ - namespace?: string; - /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { [key: string]: any }; - /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ - protocolId?: string; - /** @description The blockchain plugin or token service that detected the event */ - source?: string; - /** - * Format: date-time - * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors - */ - timestamp?: string; - /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ - tx?: { - /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ - blockchainId?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction - */ - id?: string; - /** @description The type of the FireFly transaction */ - type?: string; - }; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a list of operations in a specific transaction */ - getTxnOps: { - parameters: { - path: { - /** The transaction ID */ - txnid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time the operation was created - */ - created?: string; - /** @description Any error reported back from the plugin for this operation */ - error?: string; - /** - * Format: uuid - * @description The UUID of the operation - */ - id?: string; - /** @description The input to this operation */ - input?: { [key: string]: any }; - /** @description The namespace of the operation */ - namespace?: string; - /** @description Any output reported back from the plugin for this operation */ - output?: { [key: string]: any }; - /** @description The plugin responsible for performing the operation */ - plugin?: string; - /** - * Format: uuid - * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried - */ - retry?: string; - /** @description The current status of the operation */ - status?: string; - /** - * Format: uuid - * @description The UUID of the FireFly transaction the operation is part of - */ - tx?: string; - /** - * @description The type of the operation - * @enum {string} - */ - type?: - | "blockchain_pin_batch" - | "blockchain_network_action" - | "blockchain_deploy" - | "blockchain_invoke" - | "sharedstorage_upload_batch" - | "sharedstorage_upload_blob" - | "sharedstorage_upload_value" - | "sharedstorage_download_batch" - | "sharedstorage_download_blob" - | "dataexchange_send_batch" - | "dataexchange_send_blob" - | "token_create_pool" - | "token_activate_pool" - | "token_transfer" - | "token_approval"; - /** - * Format: date-time - * @description The last update time of the operation - */ - updated?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets the status of a transaction */ - getTxnStatus: { - parameters: { - path: { - /** The transaction ID */ - txnid: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description A set of records describing the activities within the transaction known by the local FireFly node */ - details?: { - /** @description If an error occurred related to the detail entry, it is included here */ - error?: string; - /** - * Format: uuid - * @description The UUID of the entry referenced by this detail. The type of this record can be inferred from the entry type - */ - id?: string; - /** @description Output details for this entry */ - info?: { [key: string]: any }; - /** @description The status of the detail record. Cases where an event is required for completion, but has not arrived yet are marked with a 'pending' record */ - status?: string; - /** @description A sub-type, such as an operation type, or an event type */ - subtype?: string; - /** - * Format: date-time - * @description The time relevant to when the record was updated, such as the time an event was created, or the last update time of an operation - */ - timestamp?: string; - /** @description The type of the transaction status detail record */ - type?: string; - }[]; - /** @description The overall computed status of the transaction, after analyzing the details during the API call */ - status?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Gets a list of verifiers */ - getVerifiers: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - query: { - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - created?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - hash?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - identity?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - type?: string; - /** Data filter field. Prefixes supported: > >= < <= @ ^ ! !@ !^ */ - value?: string; - /** Sort field. For multi-field sort use comma separated values (or multiple query values) with '-' prefix for descending */ - sort?: string; - /** Ascending sort order (overrides all fields in a multi-field sort) */ - ascending?: string; - /** Descending sort order (overrides all fields in a multi-field sort) */ - descending?: string; - /** The number of records to skip (max: 1,000). Unsuitable for bulk operations */ - skip?: string; - /** The maximum number of records to return (max: 1,000) */ - limit?: string; - /** Return a total count as well as items (adds extra database processing) */ - count?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time this verifier was created on this node - */ - created?: string; - /** - * Format: byte - * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the parent identity that has claimed this verifier - */ - identity?: string; - /** @description The namespace of the verifier */ - namespace?: string; - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }[]; - }; - }; - default: unknown; - }; - }; - /** Gets a verifier by its hash */ - getVerifierByID: { - parameters: { - path: { - /** The hash of the verifier */ - hash: string; - }; - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * Format: date-time - * @description The time this verifier was created on this node - */ - created?: string; - /** - * Format: byte - * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network - */ - hash?: string; - /** - * Format: uuid - * @description The UUID of the parent identity that has claimed this verifier - */ - identity?: string; - /** @description The namespace of the verifier */ - namespace?: string; - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }; - }; - }; - default: unknown; - }; - }; - /** Resolves an input key to a signing key */ - postVerifiersResolve: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }; - }; - }; - default: unknown; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The type of the verifier - * @enum {string} - */ - type?: - | "ethereum_address" - | "tezos_address" - | "fabric_msp_id" - | "dx_peer_id"; - /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ - value?: string; - }; - }; - }; - }; - /** Gets a list of the current WebSocket connections to this node */ - getWebSockets: { - parameters: { - header: { - /** Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ - "Request-Timeout"?: string; - }; - }; - responses: { - /** Success */ - 200: { - content: { - "application/json": { - /** @description List of currently active websocket client connections */ - connections?: { - /** @description The unique ID assigned to this client connection */ - id?: string; - /** @description The remote address of the connected client (if available) */ - remoteAddress?: string; - /** @description List of subscriptions currently started by this client */ - subscriptions?: { - /** @description Indicates whether the subscription is ephemeral (vs durable) */ - ephemeral?: boolean; - /** @description The subscription filter specification */ - filter?: { - /** @description Deprecated: Please use 'message.author' instead */ - author?: string; - /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ - blockchainevent?: { - /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ - listener?: string; - /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ - name?: string; - }; - /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ - events?: string; - /** @description Deprecated: Please use 'message.group' instead */ - group?: string; - /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ - message?: { - /** @description Regular expression to apply to the message 'header.author' field */ - author?: string; - /** @description Regular expression to apply to the message 'header.group' field */ - group?: string; - /** @description Regular expression to apply to the message 'header.tag' field */ - tag?: string; - }; - /** @description Deprecated: Please use 'message.tag' instead */ - tag?: string; - /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ - topic?: string; - /** @description Deprecated: Please use 'topic' instead */ - topics?: string; - /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ - transaction?: { - /** @description Regular expression to apply to the transaction 'type' field */ - type?: string; - }; + /** @description Server-side request timeout (milliseconds, or set a custom suffix like 10s) */ + "Request-Timeout"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; }; - /** @description The subscription name (for durable subscriptions only) */ - name?: string; - /** @description The subscription namespace */ - namespace?: string; - /** - * Format: date-time - * @description The time the subscription started (reset on dynamic namespace reload) - */ - startTime?: string; - }[]; - /** @description The user agent of the connected client (if available) */ - userAgent?: string; - }[]; - /** @description Indicates whether the websockets plugin is enabled */ - enabled?: boolean; - }; - }; - }; - default: unknown; - }; - }; + content: { + "application/json": { + /** @description List of currently active websocket client connections */ + connections?: { + /** @description The unique ID assigned to this client connection */ + id?: string; + /** @description The remote address of the connected client (if available) */ + remoteAddress?: string; + /** @description List of subscriptions currently started by this client */ + subscriptions?: { + /** @description Indicates whether the subscription is ephemeral (vs durable) */ + ephemeral?: boolean; + /** @description The subscription filter specification */ + filter?: { + /** @description Deprecated: Please use 'message.author' instead */ + author?: string; + /** @description Filters specific to blockchain events. If an event is not a blockchain event, these filters are ignored */ + blockchainevent?: { + /** @description Regular expression to apply to the blockchain event 'listener' field, which is the UUID of the event listener. So you can restrict your subscription to certain blockchain listeners. Alternatively to avoid your application need to know listener UUIDs you can set the 'topic' field of blockchain event listeners, and use a topic filter on your subscriptions */ + listener?: string; + /** @description Regular expression to apply to the blockchain event 'name' field, which is the name of the event in the underlying blockchain smart contract */ + name?: string; + }; + /** @description Regular expression to apply to the event type, to subscribe to a subset of event types */ + events?: string; + /** @description Deprecated: Please use 'message.group' instead */ + group?: string; + /** @description Filters specific to message events. If an event is not a message event, these filters are ignored */ + message?: { + /** @description Regular expression to apply to the message 'header.author' field */ + author?: string; + /** @description Regular expression to apply to the message 'header.group' field */ + group?: string; + /** @description Regular expression to apply to the message 'header.tag' field */ + tag?: string; + }; + /** @description Deprecated: Please use 'message.tag' instead */ + tag?: string; + /** @description Regular expression to apply to the topic of the event, to subscribe to a subset of topics. Note for messages sent with multiple topics, a separate event is emitted for each topic */ + topic?: string; + /** @description Deprecated: Please use 'topic' instead */ + topics?: string; + /** @description Filters specific to events with a transaction. If an event is not associated with a transaction, this filter is ignored */ + transaction?: { + /** @description Regular expression to apply to the transaction 'type' field */ + type?: string; + }; + }; + /** @description The subscription name (for durable subscriptions only) */ + name?: string; + /** @description The subscription namespace */ + namespace?: string; + /** + * Format: date-time + * @description The time the subscription started (reset on dynamic namespace reload) + */ + startTime?: string; + }[]; + /** @description The user agent of the connected client (if available) */ + userAgent?: string; + }[]; + /** @description Indicates whether the websockets plugin is enabled */ + enabled?: boolean; + }; + }; + }; + default: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; } - -export interface external {} From 5b881541a2a7cf38a5a1c144333c7b2f4b4d51d2 Mon Sep 17 00:00:00 2001 From: Andrew Richardson Date: Thu, 1 May 2025 11:46:15 -0400 Subject: [PATCH 4/7] Update OpenAPI schema transforms Signed-off-by: Andrew Richardson --- package.json | 4 ++-- scripts/parseSchema.ts | 38 ++++++++++++++++++++++++++++++++++++++ scripts/schema.ts | 14 -------------- 3 files changed, 40 insertions(+), 16 deletions(-) create mode 100644 scripts/parseSchema.ts delete mode 100644 scripts/schema.ts diff --git a/package.json b/package.json index ad37831..ba12f61 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "lint": "eslint \"lib/*.ts\"", "lint:fix": "eslint \"lib/*.ts\" --fix", "format": "prettier --write \"lib/*.ts\" \"examples/**/*.ts\"", - "schema": "ts-node scripts/schema.ts" + "schema": "ts-node scripts/parseSchema.ts" }, "repository": { "type": "git", @@ -45,4 +45,4 @@ "form-data": "^4.0.0", "ws": "^8.17.1" } -} +} \ No newline at end of file diff --git a/scripts/parseSchema.ts b/scripts/parseSchema.ts new file mode 100644 index 0000000..3289659 --- /dev/null +++ b/scripts/parseSchema.ts @@ -0,0 +1,38 @@ +import { promises as fs } from 'fs'; +import openapiTS, { astToString } from 'openapi-typescript'; +import * as ts from 'typescript'; +import { pathToFileURL } from 'url'; + +const STRING = ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword); +const ANY = ts.factory.createKeywordTypeNode(ts.SyntaxKind.AnyKeyword); + +async function run() { + const localPath = pathToFileURL('../firefly/doc-site/docs/swagger/swagger.yaml'); + console.log(`Generating types from ${localPath}`); + const output = await openapiTS(localPath.toString(), { + transform: (schemaObject, options) => { + if (schemaObject.type === 'object' && schemaObject.additionalProperties) { + // For objects with arbitrary properties, use "any" instead of "unknown" + return ANY; + } + + if ( + schemaObject.type === 'string' && + schemaObject.format === 'uuid' && + schemaObject.nullable && + options.path && + options.path.indexOf('/responses/') >= 0 && + options.path.endsWith('/id') + ) { + // For IDs in a response body, override to be non-nullable + schemaObject.nullable = false; + return STRING; + } + }, + }); + await fs.writeFile('lib/schema.ts', astToString(output)); +} + +run().catch((err) => { + console.error('Error running script', err); +}); diff --git a/scripts/schema.ts b/scripts/schema.ts deleted file mode 100644 index c72c008..0000000 --- a/scripts/schema.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { promises as fs } from 'fs'; -import openapiTS, { astToString } from 'openapi-typescript'; -import { pathToFileURL } from 'url'; - -async function run() { - const localPath = pathToFileURL('../firefly/doc-site/docs/swagger/swagger.yaml'); - console.log(`Generating types from ${localPath}`); - const output = await openapiTS(localPath.toString()); - await fs.writeFile('lib/schema.ts', astToString(output)); -} - -run().catch((err) => { - console.error('Error running script', err); -}); From 6660bd7de50d908bd9d1b4e888d5a3048efc8bac Mon Sep 17 00:00:00 2001 From: Andrew Richardson Date: Thu, 1 May 2025 11:46:33 -0400 Subject: [PATCH 5/7] Re-generate new schema Signed-off-by: Andrew Richardson --- lib/schema.ts | 4348 ++++++++++++++++++++++--------------------------- 1 file changed, 1917 insertions(+), 2431 deletions(-) diff --git a/lib/schema.ts b/lib/schema.ts index 6efcadb..3ef179b 100644 --- a/lib/schema.ts +++ b/lib/schema.ts @@ -3302,14 +3302,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3353,7 +3353,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Reference to the FireFly Interface definition associated with the contract API */ @@ -3362,14 +3362,14 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The published name of the API within the multiparty network */ @@ -3401,14 +3401,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3452,14 +3452,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3526,14 +3526,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3578,7 +3578,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Reference to the FireFly Interface definition associated with the contract API */ @@ -3587,14 +3587,14 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The published name of the API within the multiparty network */ @@ -3626,14 +3626,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3677,14 +3677,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3782,7 +3782,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -3792,7 +3792,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -3804,9 +3804,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -3816,7 +3814,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -3826,7 +3824,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -3842,15 +3840,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -3860,7 +3856,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -3870,7 +3866,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -3879,7 +3875,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -3921,19 +3917,17 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ message?: { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -3944,16 +3938,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -3966,7 +3960,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -3975,12 +3969,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -4000,11 +3994,9 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -4020,7 +4012,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -4029,29 +4021,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -4061,7 +4049,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -4076,7 +4064,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -4085,29 +4073,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -4117,7 +4101,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -4194,15 +4178,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -4210,9 +4192,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -4220,9 +4202,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -4230,9 +4210,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -4244,9 +4224,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -4266,9 +4246,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -4277,7 +4257,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -4308,7 +4288,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ @@ -4316,9 +4296,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -4326,18 +4304,18 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description Options that control how the listener subscribes to events from the underlying blockchain */ options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ topic?: string; }; @@ -4357,15 +4335,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -4373,9 +4349,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -4383,9 +4359,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -4393,9 +4367,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -4407,9 +4381,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -4429,9 +4403,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -4440,7 +4414,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -4472,7 +4446,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ @@ -4503,7 +4477,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -4513,7 +4487,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -4525,9 +4499,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -4537,7 +4509,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -4547,7 +4519,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -4563,15 +4535,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -4581,7 +4551,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -4591,7 +4561,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -4600,7 +4570,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -4638,7 +4608,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -4648,7 +4618,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -4660,9 +4630,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -4672,7 +4640,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -4682,7 +4650,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -4698,15 +4666,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -4716,7 +4682,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -4726,7 +4692,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -4735,7 +4701,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -4774,23 +4740,19 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -4801,9 +4763,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; default: { @@ -4876,22 +4836,22 @@ export interface operations { * Format: date-time * @description The time when the batch was confirmed */ - confirmed?: string; + confirmed?: string | null; /** * Format: date-time * @description The time the batch was sealed */ - created?: string; + created?: string | null; /** * Format: byte * @description The privacy group the batch is sent to, for private batches */ - group?: string; + group?: string | null; /** * Format: byte * @description The hash of the manifest of the batch */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the batch @@ -4900,14 +4860,14 @@ export interface operations { /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The manifest of the batch */ - manifest?: unknown; + manifest?: any; /** @description The namespace of the batch */ namespace?: string; /** * Format: uuid * @description The UUID of the node that generated the batch */ - node?: string; + node?: string | null; /** @description The FireFly transaction associated with this batch */ tx?: { /** @@ -4962,22 +4922,22 @@ export interface operations { * Format: date-time * @description The time when the batch was confirmed */ - confirmed?: string; + confirmed?: string | null; /** * Format: date-time * @description The time the batch was sealed */ - created?: string; + created?: string | null; /** * Format: byte * @description The privacy group the batch is sent to, for private batches */ - group?: string; + group?: string | null; /** * Format: byte * @description The hash of the manifest of the batch */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the batch @@ -4986,14 +4946,14 @@ export interface operations { /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The manifest of the batch */ - manifest?: unknown; + manifest?: any; /** @description The namespace of the batch */ namespace?: string; /** * Format: uuid * @description The UUID of the node that generated the batch */ - node?: string; + node?: string | null; /** @description The FireFly transaction associated with this batch */ tx?: { /** @@ -5033,7 +4993,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": unknown; }; @@ -5112,22 +5072,18 @@ export interface operations { */ id?: string; /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { - [key: string]: unknown; - }; + info?: any; /** * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string; + listener?: string | null; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ namespace?: string; /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ protocolId?: string; /** @description The blockchain plugin or token service that detected the event */ @@ -5136,7 +5092,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string; + timestamp?: string | null; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -5188,22 +5144,18 @@ export interface operations { */ id?: string; /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { - [key: string]: unknown; - }; + info?: any; /** * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string; + listener?: string | null; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ namespace?: string; /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ protocolId?: string; /** @description The blockchain plugin or token service that detected the event */ @@ -5212,7 +5164,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string; + timestamp?: string | null; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -5273,7 +5225,7 @@ export interface operations { * Format: date-time * @description Starting timestamp for the bucket */ - timestamp?: string; + timestamp?: string | null; /** @description Array of separate counts for individual types of record within the bucket */ types?: { /** @description Count of entries of a given type within a bucket */ @@ -5305,13 +5257,13 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The smart contract to deploy. This should be pre-compiled if required by the blockchain connector */ - contract?: unknown; + contract?: any; /** @description The definition of the smart contract */ - definition?: unknown; + definition?: any; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description An optional array of inputs passed to the smart contract's constructor, if applicable */ @@ -5319,9 +5271,7 @@ export interface operations { /** @description The blockchain signing key that will be used to deploy the contract. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -5337,7 +5287,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -5346,29 +5296,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -5378,7 +5324,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -5393,7 +5339,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -5402,29 +5348,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -5434,7 +5376,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -5503,7 +5445,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -5513,7 +5455,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -5525,9 +5467,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -5537,7 +5477,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -5547,7 +5487,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -5563,15 +5503,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -5581,7 +5519,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -5591,7 +5529,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -5600,7 +5538,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -5639,7 +5577,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description A description of the smart contract this FFI represents */ @@ -5655,7 +5593,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An array of smart contract event definitions */ @@ -5663,9 +5601,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -5673,7 +5609,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An array of smart contract method definitions */ @@ -5681,9 +5617,7 @@ export interface operations { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the method */ name?: string; /** @description An array of method parameter/argument definitions */ @@ -5691,14 +5625,14 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description An array of method return definitions */ returns?: { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -5733,7 +5667,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -5743,7 +5677,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -5755,9 +5689,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -5767,7 +5699,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -5777,7 +5709,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -5793,15 +5725,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -5811,7 +5741,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -5821,7 +5751,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -5830,7 +5760,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -5894,7 +5824,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -5904,7 +5834,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -5916,9 +5846,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -5928,7 +5856,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -5938,7 +5866,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -5954,15 +5882,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -5972,7 +5898,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -5982,7 +5908,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -5991,7 +5917,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -6089,7 +6015,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -6099,7 +6025,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -6111,9 +6037,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -6123,7 +6047,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -6133,7 +6057,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -6149,15 +6073,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -6167,7 +6089,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6177,7 +6099,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -6186,7 +6108,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -6228,7 +6150,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ @@ -6259,7 +6181,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -6269,7 +6191,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -6281,9 +6203,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -6293,7 +6213,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -6303,7 +6223,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -6319,15 +6239,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -6337,7 +6255,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6347,7 +6265,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -6356,7 +6274,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -6394,7 +6312,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -6404,7 +6322,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -6416,9 +6334,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -6428,7 +6344,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -6438,7 +6354,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -6454,15 +6370,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -6472,7 +6386,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6482,7 +6396,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -6491,7 +6405,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -6525,13 +6439,13 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The description of the FFI to be generated. Defaults to the description extracted by the blockchain specific converter utility */ description?: string; /** @description A blockchain connector specific payload. For example in Ethereum this is a JSON structure containing an 'abi' array, and optionally a 'devdocs' array. */ - input?: unknown; + input?: any; /** @description The name of the FFI to generate */ name?: string; /** @description The namespace into which the FFI will be generated */ @@ -6564,7 +6478,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -6574,7 +6488,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -6586,9 +6500,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -6598,7 +6510,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -6608,7 +6520,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -6624,15 +6536,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -6642,7 +6552,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6652,7 +6562,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -6661,7 +6571,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -6698,7 +6608,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ @@ -6712,24 +6622,22 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { - [key: string]: unknown; - }; + input?: any; /** * Format: uuid * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface */ - interface?: string; + interface?: string | null; /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ message?: { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -6740,16 +6648,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -6762,7 +6670,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -6771,12 +6679,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -6796,15 +6704,13 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ method?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the method */ name?: string; /** @description An array of method parameter/argument definitions */ @@ -6812,22 +6718,20 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description An array of method return definitions */ returns?: { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description The pathname of the method on the specified FFI */ methodPath?: string; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -6843,7 +6747,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -6852,29 +6756,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -6884,7 +6784,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -6899,7 +6799,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -6908,29 +6808,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -6940,7 +6836,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -7012,15 +6908,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7028,9 +6922,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -7038,9 +6932,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7048,9 +6940,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -7062,9 +6954,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -7084,9 +6976,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -7095,7 +6987,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -7121,7 +7013,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ @@ -7129,9 +7021,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7139,9 +7029,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description Deprecated: Please use 'eventPath' in the array of 'filters' instead */ eventPath?: string; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ @@ -7151,9 +7041,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7161,9 +7049,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ eventPath?: string; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ @@ -7172,14 +7060,14 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ interface?: { @@ -7187,21 +7075,21 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description Options that control how the listener subscribes to events from the underlying blockchain */ options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ topic?: string; }; @@ -7221,15 +7109,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7237,9 +7123,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -7247,9 +7133,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7257,9 +7141,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -7271,9 +7155,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -7293,9 +7177,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -7304,7 +7188,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -7351,15 +7235,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7367,9 +7249,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -7377,9 +7259,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7387,9 +7267,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -7401,9 +7281,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -7423,9 +7303,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -7434,7 +7314,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -7492,7 +7372,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ @@ -7500,9 +7380,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7510,9 +7388,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description Deprecated: Please use 'eventPath' in the array of 'filters' instead */ eventPath?: string; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ @@ -7522,9 +7400,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -7532,9 +7408,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ eventPath?: string; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ @@ -7543,14 +7419,14 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ interface?: { @@ -7558,21 +7434,21 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description Options that control how the listener subscribes to events from the underlying blockchain */ options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ topic?: string; }; @@ -7609,7 +7485,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ @@ -7623,32 +7499,28 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { - [key: string]: unknown; - }; + input?: any; /** * Format: uuid * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface */ - interface?: string; + interface?: string | null; /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ method?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the method */ name?: string; /** @description An array of method parameter/argument definitions */ @@ -7656,22 +7528,20 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description An array of method return definitions */ returns?: { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description The pathname of the method on the specified FFI */ methodPath?: string; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -7682,9 +7552,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; default: { @@ -7759,7 +7627,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -7771,24 +7639,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -7801,7 +7669,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }[]; }; }; @@ -7823,7 +7691,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The optional datatype to use for validation of the in-line data */ @@ -7832,16 +7700,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }; "multipart/form-data": { /** @description Success */ @@ -7873,7 +7741,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -7885,24 +7753,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -7915,7 +7783,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }; }; }; @@ -7955,7 +7823,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -7967,24 +7835,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -7997,7 +7865,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }; }; }; @@ -8143,7 +8011,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -8165,7 +8033,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -8177,24 +8045,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -8207,7 +8075,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }; }; }; @@ -8302,19 +8170,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -8325,7 +8193,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -8334,22 +8202,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -8372,7 +8240,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -8401,7 +8269,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -8515,7 +8383,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -8537,7 +8405,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -8549,24 +8417,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -8579,7 +8447,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }; }; }; @@ -8671,12 +8539,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string; + created?: string | null; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the datatype @@ -8686,7 +8554,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string; + message?: string | null; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -8697,7 +8565,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }[]; @@ -8724,7 +8592,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The name of the datatype */ @@ -8735,7 +8603,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }; @@ -8753,12 +8621,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string; + created?: string | null; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the datatype @@ -8768,7 +8636,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string; + message?: string | null; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -8779,7 +8647,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }; @@ -8796,12 +8664,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string; + created?: string | null; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the datatype @@ -8811,7 +8679,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string; + message?: string | null; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -8822,7 +8690,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }; @@ -8864,12 +8732,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string; + created?: string | null; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the datatype @@ -8879,7 +8747,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string; + message?: string | null; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -8890,7 +8758,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }; @@ -8960,12 +8828,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string; + correlator?: string | null; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -8977,7 +8845,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string; + reference?: string | null; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -8989,7 +8857,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string; + tx?: string | null; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -9035,12 +8903,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string; + correlator?: string | null; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -9052,7 +8920,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string; + reference?: string | null; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -9064,7 +8932,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string; + tx?: string | null; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -9127,12 +8995,12 @@ export interface operations { * Format: date-time * @description The time when the group was first used to send a message in the network */ - created?: string; + created?: string | null; /** * Format: byte * @description The identifier hash of this group. Derived from the name and group members */ - hash?: string; + hash?: string | null; /** @description The local namespace of the group */ localNamespace?: string; /** @description The list of members in this privacy group */ @@ -9143,13 +9011,13 @@ export interface operations { * Format: uuid * @description The UUID of the node that receives a copy of the off-chain message for the identity */ - node?: string; + node?: string | null; }[]; /** * Format: uuid * @description The message used to broadcast this group privately to the members */ - message?: string; + message?: string | null; /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ name?: string; /** @description The namespace of the group within the multiparty network */ @@ -9191,12 +9059,12 @@ export interface operations { * Format: date-time * @description The time when the group was first used to send a message in the network */ - created?: string; + created?: string | null; /** * Format: byte * @description The identifier hash of this group. Derived from the name and group members */ - hash?: string; + hash?: string | null; /** @description The local namespace of the group */ localNamespace?: string; /** @description The list of members in this privacy group */ @@ -9207,13 +9075,13 @@ export interface operations { * Format: uuid * @description The UUID of the node that receives a copy of the off-chain message for the identity */ - node?: string; + node?: string | null; }[]; /** * Format: uuid * @description The message used to broadcast this group privately to the members */ - message?: string; + message?: string | null; /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ name?: string; /** @description The namespace of the group within the multiparty network */ @@ -9291,7 +9159,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9307,17 +9175,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9327,11 +9195,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -9341,7 +9207,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -9376,7 +9242,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description A description of the identity. Part of the updatable profile information of an identity */ @@ -9388,9 +9254,7 @@ export interface operations { /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** @description The type of the identity */ type?: string; }; @@ -9408,7 +9272,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9424,17 +9288,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9444,11 +9308,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -9458,7 +9320,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -9473,7 +9335,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9489,17 +9351,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9509,11 +9371,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -9523,7 +9383,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -9564,7 +9424,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9580,17 +9440,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9600,11 +9460,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -9614,7 +9472,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -9642,15 +9500,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; }; }; }; @@ -9666,7 +9522,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9682,17 +9538,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9702,11 +9558,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -9716,7 +9570,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -9731,7 +9585,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9747,17 +9601,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9767,11 +9621,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -9781,7 +9633,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -9896,17 +9748,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string; + created?: string | null; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string; + identity?: string | null; /** @description The namespace of the verifier */ namespace?: string; /** @@ -10009,19 +9861,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10032,7 +9884,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10041,22 +9893,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10079,7 +9931,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10108,7 +9960,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }[]; }; }; @@ -10149,12 +10001,12 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ data?: { /** @description An optional in-line hash reference to a previously uploaded binary data blob */ @@ -10163,7 +10015,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -10175,19 +10027,19 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** @description The optional datatype to use for validation of the in-line data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10196,7 +10048,7 @@ export interface operations { /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -10209,12 +10061,12 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10223,22 +10075,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10261,7 +10113,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10290,7 +10142,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -10330,7 +10182,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -10342,24 +10194,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -10372,7 +10224,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }[]; }; }; @@ -10439,12 +10291,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string; + correlator?: string | null; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -10456,7 +10308,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string; + reference?: string | null; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -10468,7 +10320,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string; + tx?: string | null; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -10513,7 +10365,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -10552,7 +10404,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -10563,16 +10415,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description The message header contains all fields that are used to build the message hash */ header?: { @@ -10582,7 +10434,7 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -10617,19 +10469,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10640,7 +10492,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10649,17 +10501,17 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10682,7 +10534,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10711,7 +10563,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -10726,19 +10578,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10749,7 +10601,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10758,17 +10610,17 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10791,7 +10643,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10820,7 +10672,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -10845,7 +10697,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -10856,16 +10708,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -10878,7 +10730,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10887,12 +10739,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -10927,19 +10779,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10950,7 +10802,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10959,22 +10811,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10997,7 +10849,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -11026,7 +10878,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -11041,19 +10893,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -11064,7 +10916,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -11073,22 +10925,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -11111,7 +10963,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -11140,7 +10992,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -11162,7 +11014,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -11173,16 +11025,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -11195,7 +11047,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -11204,12 +11056,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -11244,12 +11096,12 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ data?: { /** @description An optional in-line hash reference to a previously uploaded binary data blob */ @@ -11258,7 +11110,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -11270,19 +11122,19 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** @description The optional datatype to use for validation of the in-line data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -11291,7 +11143,7 @@ export interface operations { /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -11304,12 +11156,12 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -11318,22 +11170,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -11356,7 +11208,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -11385,7 +11237,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -11423,7 +11275,7 @@ export interface operations { * Format: date-time * @description The time the namespace was created */ - created?: string; + created?: string | null; /** @description A description of the namespace */ description?: string; /** @description Set to a non-empty string in the case that the namespace is currently failing to initialize */ @@ -11471,7 +11323,7 @@ export interface operations { * Format: date-time * @description The time the namespace was created */ - created?: string; + created?: string | null; /** @description A description of the namespace */ description?: string; /** @description The local namespace name */ @@ -11550,14 +11402,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11604,7 +11456,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Reference to the FireFly Interface definition associated with the contract API */ @@ -11613,14 +11465,14 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The published name of the API within the multiparty network */ @@ -11652,14 +11504,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11703,14 +11555,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11779,14 +11631,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11833,7 +11685,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Reference to the FireFly Interface definition associated with the contract API */ @@ -11842,14 +11694,14 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The published name of the API within the multiparty network */ @@ -11881,14 +11733,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11932,14 +11784,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string; + message?: string | null; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -12041,7 +11893,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -12051,7 +11903,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -12063,9 +11915,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -12075,7 +11925,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -12085,7 +11935,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -12101,15 +11951,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -12119,7 +11967,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -12129,7 +11977,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -12138,7 +11986,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -12182,7 +12030,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ @@ -12196,24 +12044,22 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { - [key: string]: unknown; - }; + input?: any; /** * Format: uuid * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface */ - interface?: string; + interface?: string | null; /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ message?: { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -12224,16 +12070,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -12246,7 +12092,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -12255,12 +12101,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -12280,15 +12126,13 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ method?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the method */ name?: string; /** @description An array of method parameter/argument definitions */ @@ -12296,22 +12140,20 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description An array of method return definitions */ returns?: { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description The pathname of the method on the specified FFI */ methodPath?: string; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -12327,7 +12169,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -12336,29 +12178,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -12368,7 +12206,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -12383,7 +12221,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -12392,29 +12230,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -12424,7 +12258,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -12503,15 +12337,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -12519,9 +12351,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -12529,9 +12361,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -12539,9 +12369,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -12553,9 +12383,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -12575,9 +12405,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -12586,7 +12416,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -12619,7 +12449,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ @@ -12627,9 +12457,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -12637,9 +12465,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -12647,9 +12475,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -12657,23 +12483,23 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ interface?: { @@ -12681,21 +12507,21 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description Options that control how the listener subscribes to events from the underlying blockchain */ options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ topic?: string; }; @@ -12715,15 +12541,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -12731,9 +12555,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -12741,9 +12565,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -12751,9 +12573,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -12765,9 +12587,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -12787,9 +12609,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -12798,7 +12620,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -12832,7 +12654,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ @@ -12863,7 +12685,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -12873,7 +12695,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -12885,9 +12707,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -12897,7 +12717,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -12907,7 +12727,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -12923,15 +12743,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -12941,7 +12759,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -12951,7 +12769,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -12960,7 +12778,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -12998,7 +12816,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -13008,7 +12826,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -13020,9 +12838,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -13032,7 +12848,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -13042,7 +12858,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -13058,15 +12874,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -13076,7 +12890,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -13086,7 +12900,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -13095,7 +12909,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -13136,7 +12950,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ @@ -13150,24 +12964,22 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { - [key: string]: unknown; - }; + input?: any; /** * Format: uuid * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface */ - interface?: string; + interface?: string | null; /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ message?: { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -13178,16 +12990,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -13200,7 +13012,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -13209,12 +13021,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -13234,15 +13046,13 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ method?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the method */ name?: string; /** @description An array of method parameter/argument definitions */ @@ -13250,22 +13060,20 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description An array of method return definitions */ returns?: { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description The pathname of the method on the specified FFI */ methodPath?: string; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -13276,9 +13084,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; default: { @@ -13354,22 +13160,22 @@ export interface operations { * Format: date-time * @description The time when the batch was confirmed */ - confirmed?: string; + confirmed?: string | null; /** * Format: date-time * @description The time the batch was sealed */ - created?: string; + created?: string | null; /** * Format: byte * @description The privacy group the batch is sent to, for private batches */ - group?: string; + group?: string | null; /** * Format: byte * @description The hash of the manifest of the batch */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the batch @@ -13378,14 +13184,14 @@ export interface operations { /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The manifest of the batch */ - manifest?: unknown; + manifest?: any; /** @description The namespace of the batch */ namespace?: string; /** * Format: uuid * @description The UUID of the node that generated the batch */ - node?: string; + node?: string | null; /** @description The FireFly transaction associated with this batch */ tx?: { /** @@ -13442,22 +13248,22 @@ export interface operations { * Format: date-time * @description The time when the batch was confirmed */ - confirmed?: string; + confirmed?: string | null; /** * Format: date-time * @description The time the batch was sealed */ - created?: string; + created?: string | null; /** * Format: byte * @description The privacy group the batch is sent to, for private batches */ - group?: string; + group?: string | null; /** * Format: byte * @description The hash of the manifest of the batch */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the batch @@ -13466,14 +13272,14 @@ export interface operations { /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The manifest of the batch */ - manifest?: unknown; + manifest?: any; /** @description The namespace of the batch */ namespace?: string; /** * Format: uuid * @description The UUID of the node that generated the batch */ - node?: string; + node?: string | null; /** @description The FireFly transaction associated with this batch */ tx?: { /** @@ -13515,7 +13321,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": unknown; }; @@ -13597,22 +13403,18 @@ export interface operations { */ id?: string; /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { - [key: string]: unknown; - }; + info?: any; /** * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string; + listener?: string | null; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ namespace?: string; /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ protocolId?: string; /** @description The blockchain plugin or token service that detected the event */ @@ -13621,7 +13423,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string; + timestamp?: string | null; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -13675,22 +13477,18 @@ export interface operations { */ id?: string; /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { - [key: string]: unknown; - }; + info?: any; /** * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string; + listener?: string | null; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ namespace?: string; /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ protocolId?: string; /** @description The blockchain plugin or token service that detected the event */ @@ -13699,7 +13497,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string; + timestamp?: string | null; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -13762,7 +13560,7 @@ export interface operations { * Format: date-time * @description Starting timestamp for the bucket */ - timestamp?: string; + timestamp?: string | null; /** @description Array of separate counts for individual types of record within the bucket */ types?: { /** @description Count of entries of a given type within a bucket */ @@ -13797,13 +13595,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The smart contract to deploy. This should be pre-compiled if required by the blockchain connector */ - contract?: unknown; + contract?: any; /** @description The definition of the smart contract */ - definition?: unknown; + definition?: any; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description An optional array of inputs passed to the smart contract's constructor, if applicable */ @@ -13811,9 +13609,7 @@ export interface operations { /** @description The blockchain signing key that will be used to deploy the contract. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -13829,7 +13625,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -13838,29 +13634,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -13870,7 +13662,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -13885,7 +13677,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -13894,29 +13686,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -13926,7 +13714,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -13998,7 +13786,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14008,7 +13796,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -14020,9 +13808,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -14032,7 +13818,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14042,7 +13828,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -14058,15 +13844,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -14076,7 +13860,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14086,7 +13870,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -14095,7 +13879,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -14137,7 +13921,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description A description of the smart contract this FFI represents */ @@ -14153,7 +13937,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An array of smart contract event definitions */ @@ -14161,9 +13945,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -14171,7 +13953,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An array of smart contract method definitions */ @@ -14179,9 +13961,7 @@ export interface operations { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the method */ name?: string; /** @description An array of method parameter/argument definitions */ @@ -14189,14 +13969,14 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description An array of method return definitions */ returns?: { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -14231,7 +14011,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14241,7 +14021,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -14253,9 +14033,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -14265,7 +14043,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14275,7 +14053,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -14291,15 +14069,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -14309,7 +14085,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14319,7 +14095,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -14328,7 +14104,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -14394,7 +14170,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14404,7 +14180,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -14416,9 +14192,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -14428,7 +14202,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14438,7 +14212,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -14454,15 +14228,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -14472,7 +14244,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14482,7 +14254,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -14491,7 +14263,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -14593,7 +14365,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14603,7 +14375,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -14615,9 +14387,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -14627,7 +14397,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14637,7 +14407,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -14653,15 +14423,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -14671,7 +14439,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14681,7 +14449,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -14690,7 +14458,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -14734,7 +14502,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ @@ -14765,7 +14533,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14775,7 +14543,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -14787,9 +14555,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -14799,7 +14565,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14809,7 +14575,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -14825,15 +14591,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -14843,7 +14607,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14853,7 +14617,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -14862,7 +14626,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -14900,7 +14664,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14910,7 +14674,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -14922,9 +14686,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -14934,7 +14696,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14944,7 +14706,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -14960,15 +14722,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -14978,7 +14738,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14988,7 +14748,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -14997,7 +14757,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -15034,13 +14794,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The description of the FFI to be generated. Defaults to the description extracted by the blockchain specific converter utility */ description?: string; /** @description A blockchain connector specific payload. For example in Ethereum this is a JSON structure containing an 'abi' array, and optionally a 'devdocs' array. */ - input?: unknown; + input?: any; /** @description The name of the FFI to generate */ name?: string; /** @description The namespace into which the FFI will be generated */ @@ -15073,7 +14833,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string; + interface?: string | null; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -15083,7 +14843,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this error within the FFI for use on URL paths */ pathname?: string; @@ -15095,9 +14855,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI event definition @@ -15107,7 +14865,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string; + interface?: string | null; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -15117,7 +14875,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this event within the FFI for use on URL paths. Supports contracts that have multiple event overrides with the same name */ pathname?: string; @@ -15133,15 +14891,13 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string; + message?: string | null; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** * Format: uuid * @description The UUID of the FFI method definition @@ -15151,7 +14907,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string; + interface?: string | null; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -15161,7 +14917,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description The unique name allocated to this method within the FFI for use on URL paths. Supports contracts that have multiple method overrides with the same name */ pathname?: string; @@ -15170,7 +14926,7 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description The name of the FFI - usually matching the smart contract name */ @@ -15210,7 +14966,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ @@ -15224,24 +14980,22 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { - [key: string]: unknown; - }; + input?: any; /** * Format: uuid * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface */ - interface?: string; + interface?: string | null; /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ message?: { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -15252,16 +15006,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -15274,7 +15028,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -15283,12 +15037,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -15308,15 +15062,13 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ method?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the method */ name?: string; /** @description An array of method parameter/argument definitions */ @@ -15324,22 +15076,20 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description An array of method return definitions */ returns?: { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description The pathname of the method on the specified FFI */ methodPath?: string; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -15355,7 +15105,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -15364,29 +15114,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -15396,7 +15142,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -15411,7 +15157,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -15420,29 +15166,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -15452,7 +15194,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -15527,15 +15269,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -15543,9 +15283,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -15553,9 +15293,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -15563,9 +15301,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -15577,9 +15315,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -15599,9 +15337,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -15610,7 +15348,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -15639,7 +15377,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ @@ -15647,9 +15385,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -15657,9 +15393,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description Deprecated: Please use 'eventPath' in the array of 'filters' instead */ eventPath?: string; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ @@ -15669,9 +15405,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -15679,9 +15413,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ eventPath?: string; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ @@ -15690,14 +15424,14 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ interface?: { @@ -15705,21 +15439,21 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description Options that control how the listener subscribes to events from the underlying blockchain */ options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ topic?: string; }; @@ -15739,15 +15473,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -15755,9 +15487,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -15765,9 +15497,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -15775,9 +15505,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -15789,9 +15519,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -15811,9 +15541,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -15822,7 +15552,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -15871,15 +15601,13 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string; + created?: string | null; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -15887,9 +15615,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -15897,9 +15625,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -15907,9 +15633,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -15921,9 +15647,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; }[]; @@ -15943,9 +15669,9 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description The namespace of the listener, which defines the namespace of all blockchain events detected by this listener */ @@ -15954,7 +15680,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -16017,7 +15743,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ @@ -16025,9 +15751,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -16035,9 +15759,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description Deprecated: Please use 'eventPath' in the array of 'filters' instead */ eventPath?: string; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ @@ -16047,9 +15771,7 @@ export interface operations { /** @description A description of the smart contract event */ description?: string; /** @description Additional blockchain specific fields about this event from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the event */ name?: string; /** @description An array of event parameter/argument definitions */ @@ -16057,9 +15779,9 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description When creating a listener from an existing FFI, this is the pathname of the event on that FFI to be detected by this listener */ eventPath?: string; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ @@ -16068,14 +15790,14 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; /** @description Deprecated: Please use 'interface' in the array of 'filters' instead */ interface?: { @@ -16083,21 +15805,21 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ - location?: unknown; + location?: any; /** @description A descriptive name for the listener */ name?: string; /** @description Options that control how the listener subscribes to events from the underlying blockchain */ options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - }; + } | null; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ topic?: string; }; @@ -16137,7 +15859,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An in-line FFI errors definition for the method to invoke. Alternative to specifying FFI */ @@ -16151,24 +15873,22 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; }[]; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description A map of named inputs. The name and type of each input must be compatible with the FFI description of the method, so that FireFly knows how to serialize it to the blockchain via the connector */ - input?: { - [key: string]: unknown; - }; + input?: any; /** * Format: uuid * @description The UUID of a method within a pre-configured FireFly interface (FFI) definition for a smart contract. Required if the 'method' is omitted. Also see Contract APIs as a way to configure a dedicated API for your FFI, including all methods and an OpenAPI/Swagger interface */ - interface?: string; + interface?: string | null; /** @description The blockchain signing key that will sign the invocation. Defaults to the first signing key of the organization that operates the node */ key?: string; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description You can specify a message to correlate with the invocation, which can be of type broadcast or private. Your specified method must support on-chain/off-chain correlation by taking a data input on the call */ message?: { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -16179,16 +15899,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -16201,7 +15921,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -16210,12 +15930,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -16235,15 +15955,13 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description An in-line FFI method definition for the method to invoke. Required when FFI is not specified */ method?: { /** @description A description of the smart contract method */ description?: string; /** @description Additional blockchain specific fields about this method from the original smart contract. Used by the blockchain plugin and for documentation generation. */ - details?: { - [key: string]: unknown; - }; + details?: any; /** @description The name of the method */ name?: string; /** @description An array of method parameter/argument definitions */ @@ -16251,22 +15969,20 @@ export interface operations { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; /** @description An array of method return definitions */ returns?: { /** @description The name of the parameter. Note that parameters must be ordered correctly on the FFI, according to the order in the blockchain smart contract */ name?: string; /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ - schema?: unknown; + schema?: any; }[]; - }; + } | null; /** @description The pathname of the method on the specified FFI */ methodPath?: string; /** @description A map of named inputs that will be passed through to the blockchain connector */ - options?: { - [key: string]: unknown; - }; + options?: any; }; }; }; @@ -16277,9 +15993,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; default: { @@ -16357,7 +16071,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16369,24 +16083,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -16399,7 +16113,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }[]; }; }; @@ -16424,7 +16138,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The optional datatype to use for validation of the in-line data */ @@ -16433,16 +16147,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }; "multipart/form-data": { /** @description Success */ @@ -16474,7 +16188,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16486,24 +16200,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -16516,7 +16230,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }; }; }; @@ -16558,7 +16272,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16570,24 +16284,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -16600,7 +16314,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }; }; }; @@ -16752,7 +16466,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -16774,7 +16488,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16786,24 +16500,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -16816,7 +16530,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }; }; }; @@ -16913,19 +16627,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -16936,7 +16650,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -16945,22 +16659,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -16983,7 +16697,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -17012,7 +16726,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -17130,7 +16844,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -17152,7 +16866,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -17164,24 +16878,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -17194,7 +16908,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }; }; }; @@ -17291,12 +17005,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string; + created?: string | null; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the datatype @@ -17306,7 +17020,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string; + message?: string | null; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -17317,7 +17031,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }[]; @@ -17347,7 +17061,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The name of the datatype */ @@ -17358,7 +17072,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }; @@ -17376,12 +17090,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string; + created?: string | null; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the datatype @@ -17391,7 +17105,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string; + message?: string | null; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -17402,7 +17116,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }; @@ -17419,12 +17133,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string; + created?: string | null; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the datatype @@ -17434,7 +17148,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string; + message?: string | null; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -17445,7 +17159,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }; @@ -17489,12 +17203,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string; + created?: string | null; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the datatype @@ -17504,7 +17218,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string; + message?: string | null; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -17515,7 +17229,7 @@ export interface operations { */ validator?: "json" | "none" | "definition"; /** @description The definition of the datatype, in the syntax supported by the validator (such as a JSON Schema definition) */ - value?: unknown; + value?: any; /** @description The version of the datatype. Multiple versions can exist with the same name. Use of semantic versioning is encourages, such as v1.0.1 */ version?: string; }; @@ -17588,12 +17302,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string; + correlator?: string | null; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -17605,7 +17319,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string; + reference?: string | null; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -17617,7 +17331,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string; + tx?: string | null; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -17665,12 +17379,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string; + correlator?: string | null; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -17682,7 +17396,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string; + reference?: string | null; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -17694,7 +17408,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string; + tx?: string | null; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -17760,12 +17474,12 @@ export interface operations { * Format: date-time * @description The time when the group was first used to send a message in the network */ - created?: string; + created?: string | null; /** * Format: byte * @description The identifier hash of this group. Derived from the name and group members */ - hash?: string; + hash?: string | null; /** @description The local namespace of the group */ localNamespace?: string; /** @description The list of members in this privacy group */ @@ -17776,13 +17490,13 @@ export interface operations { * Format: uuid * @description The UUID of the node that receives a copy of the off-chain message for the identity */ - node?: string; + node?: string | null; }[]; /** * Format: uuid * @description The message used to broadcast this group privately to the members */ - message?: string; + message?: string | null; /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ name?: string; /** @description The namespace of the group within the multiparty network */ @@ -17826,12 +17540,12 @@ export interface operations { * Format: date-time * @description The time when the group was first used to send a message in the network */ - created?: string; + created?: string | null; /** * Format: byte * @description The identifier hash of this group. Derived from the name and group members */ - hash?: string; + hash?: string | null; /** @description The local namespace of the group */ localNamespace?: string; /** @description The list of members in this privacy group */ @@ -17842,13 +17556,13 @@ export interface operations { * Format: uuid * @description The UUID of the node that receives a copy of the off-chain message for the identity */ - node?: string; + node?: string | null; }[]; /** * Format: uuid * @description The message used to broadcast this group privately to the members */ - message?: string; + message?: string | null; /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ name?: string; /** @description The namespace of the group within the multiparty network */ @@ -17929,7 +17643,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -17945,17 +17659,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -17965,11 +17679,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -17979,7 +17691,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -18017,7 +17729,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description A description of the identity. Part of the updatable profile information of an identity */ @@ -18029,9 +17741,7 @@ export interface operations { /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** @description The type of the identity */ type?: string; }; @@ -18049,7 +17759,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -18065,17 +17775,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -18085,11 +17795,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -18099,7 +17807,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -18114,7 +17822,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -18130,17 +17838,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -18150,11 +17858,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -18164,7 +17870,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -18207,7 +17913,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -18223,17 +17929,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -18243,11 +17949,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -18257,7 +17961,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -18287,15 +17991,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; }; }; }; @@ -18311,7 +18013,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -18327,17 +18029,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -18347,11 +18049,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -18361,7 +18061,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -18376,7 +18076,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -18392,17 +18092,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -18412,11 +18112,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -18426,7 +18124,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -18545,17 +18243,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string; + created?: string | null; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string; + identity?: string | null; /** @description The namespace of the verifier */ namespace?: string; /** @@ -18661,19 +18359,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -18684,7 +18382,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -18693,22 +18391,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -18731,7 +18429,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -18760,7 +18458,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }[]; }; }; @@ -18803,12 +18501,12 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ data?: { /** @description An optional in-line hash reference to a previously uploaded binary data blob */ @@ -18817,7 +18515,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -18829,19 +18527,19 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** @description The optional datatype to use for validation of the in-line data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -18850,7 +18548,7 @@ export interface operations { /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -18863,12 +18561,12 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -18877,22 +18575,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -18915,7 +18613,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -18944,7 +18642,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -18986,7 +18684,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -18998,24 +18696,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** * Format: date-time * @description The creation time of the data resource */ - created?: string; + created?: string | null; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the data resource @@ -19028,7 +18726,7 @@ export interface operations { /** @description The data validator type */ validator?: string; /** @description The value for the data, stored in the FireFly core database. Can be any JSON type - object, array, string, number or boolean. Can be combined with a binary blob attachment */ - value?: unknown; + value?: any; }[]; }; }; @@ -19097,12 +18795,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string; + correlator?: string | null; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -19114,7 +18812,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string; + reference?: string | null; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -19126,7 +18824,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string; + tx?: string | null; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -19173,7 +18871,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -19215,7 +18913,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -19226,16 +18924,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -19248,7 +18946,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19257,12 +18955,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -19297,19 +18995,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19320,7 +19018,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19329,22 +19027,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19367,7 +19065,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19396,7 +19094,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -19411,19 +19109,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19434,7 +19132,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19443,22 +19141,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19481,7 +19179,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19510,7 +19208,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -19538,7 +19236,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -19549,16 +19247,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -19571,7 +19269,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19580,12 +19278,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -19620,19 +19318,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19643,7 +19341,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19652,22 +19350,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19690,7 +19388,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19719,7 +19417,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -19734,19 +19432,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19757,7 +19455,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19766,22 +19464,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19804,7 +19502,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19833,7 +19531,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -19858,7 +19556,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ @@ -19869,16 +19567,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -19891,7 +19589,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19900,12 +19598,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -19940,12 +19638,12 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string; + batch?: string | null; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string; + confirmed?: string | null; /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ data?: { /** @description An optional in-line hash reference to a previously uploaded binary data blob */ @@ -19954,7 +19652,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string; + hash?: string | null; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -19966,19 +19664,19 @@ export interface operations { * @description The size of the binary data */ size?: number; - }; + } | null; /** @description The optional datatype to use for validation of the in-line data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: byte * @description The hash of the referenced data */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19987,7 +19685,7 @@ export interface operations { /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -20000,12 +19698,12 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string; + hash?: string | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -20014,22 +19712,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: date-time * @description The creation time of the message */ - created?: string; + created?: string | null; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string; + datahash?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -20052,7 +19750,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - }; + } | null; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -20081,7 +19779,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string; + txid?: string | null; }; }; }; @@ -20106,7 +19804,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @@ -20262,7 +19960,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20278,17 +19976,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20298,11 +19996,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -20312,7 +20008,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -20365,7 +20061,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20381,17 +20077,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20401,11 +20097,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -20415,7 +20109,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -20500,7 +20194,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20516,17 +20210,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20536,11 +20230,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -20550,7 +20242,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -20590,7 +20282,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20606,17 +20298,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20626,11 +20318,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -20640,7 +20330,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -20668,11 +20358,9 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; responses: { @@ -20687,7 +20375,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20703,17 +20391,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20723,11 +20411,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -20737,7 +20423,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -20752,7 +20438,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20768,17 +20454,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20788,11 +20474,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -20802,7 +20486,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -20877,7 +20561,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20893,17 +20577,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20913,11 +20597,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -20927,7 +20609,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -20955,7 +20637,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description A description of the identity. Part of the updatable profile information of an identity */ @@ -20967,9 +20649,7 @@ export interface operations { /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** @description The type of the identity */ type?: string; }; @@ -20987,7 +20667,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -21003,17 +20683,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -21023,11 +20703,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -21037,7 +20715,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -21052,7 +20730,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -21068,17 +20746,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -21088,11 +20766,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -21102,7 +20778,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -21142,7 +20818,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -21158,17 +20834,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -21178,11 +20854,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -21192,7 +20866,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -21220,11 +20894,9 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; responses: { @@ -21239,7 +20911,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -21255,17 +20927,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -21275,11 +20947,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -21289,7 +20959,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -21304,7 +20974,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -21320,17 +20990,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -21340,11 +21010,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -21354,7 +21022,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -21413,12 +21081,12 @@ export interface operations { * Format: byte * @description The context the next-pin applies to - the hash of the privacy group-hash + topic. The group-hash is only known to the participants (can itself contain a salt in the group-name). This context is combined with the member and nonce to determine the final hash that is written on-chain */ - context?: string; + context?: string | null; /** * Format: byte * @description The unique masked pin string */ - hash?: string; + hash?: string | null; /** @description The member of the privacy group the next-pin applies to */ identity?: string; /** @description The namespace of the next-pin */ @@ -21500,7 +21168,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -21509,29 +21177,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -21541,7 +21205,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -21584,7 +21248,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Additional detailed information about an operation provided by the connector */ detail?: unknown; /** @description Any error reported back from the plugin for this operation */ @@ -21595,29 +21259,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -21627,7 +21287,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -21654,11 +21314,9 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; responses: { @@ -21673,7 +21331,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -21682,29 +21340,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -21714,7 +21368,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -21779,24 +21433,24 @@ export interface operations { * Format: uuid * @description The UUID of the batch of messages this pin is part of */ - batch?: string; + batch?: string | null; /** * Format: byte * @description The manifest hash batch of messages this pin is part of */ - batchHash?: string; + batchHash?: string | null; /** * Format: date-time * @description The time the FireFly node created the pin */ - created?: string; + created?: string | null; /** @description Once true, this pin has been processed and will not be processed again */ dispatched?: boolean; /** * Format: byte * @description The hash represents a topic within a message in the batch. If a message has multiple topics, then multiple pins are created. If the message is private, the hash is masked for privacy */ - hash?: string; + hash?: string | null; /** * Format: int64 * @description The index of this pin within the batch. One pin is created for each topic, of each message in the batch @@ -21837,14 +21491,14 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** * Format: uuid * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified */ - batch?: string; + batch?: string | null; /** * Format: int64 * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified @@ -21865,7 +21519,7 @@ export interface operations { * Format: uuid * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified */ - batch?: string; + batch?: string | null; /** * Format: int64 * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified @@ -21924,8 +21578,8 @@ export interface operations { version?: number; }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; - }; + location?: any; + } | null; /** @description Previously-terminated FireFly smart contracts */ terminated?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ @@ -21942,9 +21596,9 @@ export interface operations { version?: number; }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; - }; + } | null; /** @description Whether multi-party mode is enabled for this namespace */ enabled?: boolean; }; @@ -21954,14 +21608,14 @@ export interface operations { * Format: date-time * @description The time the namespace was created */ - created?: string; + created?: string | null; /** @description A description of the namespace */ description?: string; /** @description The local namespace name */ name?: string; /** @description The shared namespace name within the multiparty network */ networkName?: string; - }; + } | null; /** @description Details of the local node */ node?: { /** @@ -21973,7 +21627,7 @@ export interface operations { name?: string; /** @description Whether the node has been successfully registered */ registered?: boolean; - }; + } | null; /** @description Details of the root organization identity registered for this namespace on the local node */ org?: { /** @description The DID of the organization identity, if registered */ @@ -21997,7 +21651,7 @@ export interface operations { /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ value?: string; }[]; - }; + } | null; /** @description Information about plugins configured on this namespace */ plugins?: { /** @description The blockchain plugins on this namespace */ @@ -22119,19 +21773,19 @@ export interface operations { * Format: uuid * @description If a flush is in progress, this is the UUID of the batch being flushed */ - flushing?: string; + flushing?: string | null; /** @description The last error received by this batch processor while flushing */ lastFlushError?: string; /** * Format: date-time * @description The time of the last flush */ - lastFlushErrorTime?: string; + lastFlushErrorTime?: string | null; /** * Format: date-time * @description The last time a flush was performed */ - lastFlushStartTime?: string; + lastFlushStartTime?: string | null; /** * Format: int64 * @description The total count of batches flushed by this processor since it started @@ -22195,10 +21849,10 @@ export interface operations { version?: number; }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The status of the contract listener. One of 'syncing', 'synced', or 'unknown' */ status?: string; - }; + } | null; /** @description Previously-terminated FireFly smart contracts */ terminated?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ @@ -22215,9 +21869,9 @@ export interface operations { version?: number; }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; - }; + } | null; /** @description Whether multi-party mode is enabled for this namespace */ enabled?: boolean; /** @description Details of the local node */ @@ -22226,7 +21880,7 @@ export interface operations { * Format: uuid * @description The ID of the pending message that broadcast the identity claim to the network */ - pendingRegistrationMessageId?: string; + pendingRegistrationMessageId?: string | null; /** @description The status of the node registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ status?: string; }; @@ -22236,7 +21890,7 @@ export interface operations { * Format: uuid * @description The ID of the pending message that broadcast the identity claim to the network */ - pendingRegistrationMessageId?: string; + pendingRegistrationMessageId?: string | null; /** @description The status of the organization registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ status?: string; }; @@ -22304,7 +21958,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string; + created?: string | null; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -22355,17 +22009,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -22377,7 +22029,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22401,11 +22053,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -22428,7 +22078,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -22436,7 +22086,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -22461,7 +22111,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Server-side filter to apply to events */ @@ -22507,17 +22157,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -22529,7 +22177,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22553,11 +22201,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -22580,7 +22226,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -22599,7 +22245,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string; + created?: string | null; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -22650,17 +22296,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -22672,7 +22316,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22696,11 +22340,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -22723,7 +22365,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -22731,7 +22373,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string; + updated?: string | null; }; }; }; @@ -22756,7 +22398,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Server-side filter to apply to events */ @@ -22802,17 +22444,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -22824,7 +22464,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22848,11 +22488,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -22875,7 +22513,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -22894,7 +22532,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string; + created?: string | null; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -22945,17 +22583,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -22967,7 +22603,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22991,11 +22627,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -23018,7 +22652,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -23026,7 +22660,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string; + updated?: string | null; }; }; }; @@ -23069,7 +22703,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string; + created?: string | null; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -23120,17 +22754,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -23142,7 +22774,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -23166,11 +22798,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -23193,7 +22823,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -23201,7 +22831,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string; + updated?: string | null; }; }; }; @@ -23308,12 +22938,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string; + correlator?: string | null; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -23325,7 +22955,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string; + reference?: string | null; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -23337,7 +22967,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string; + tx?: string | null; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -23451,7 +23081,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this balance entry applies to */ - pool?: string; + pool?: string | null; }[]; }; }; @@ -23536,35 +23166,33 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string; + created?: string | null; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ key?: string; /** * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -23573,7 +23201,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -23615,15 +23243,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ approved?: boolean; /** @description Input only field, with token connector specific configuration of the approval. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ @@ -23638,16 +23264,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -23660,7 +23286,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -23669,12 +23295,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -23694,14 +23320,14 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description The blockchain identity that is granted the approval */ operator?: string; /** * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string; + pool?: string | null; }; }; }; @@ -23721,35 +23347,33 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string; + created?: string | null; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ key?: string; /** * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -23758,7 +23382,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -23791,35 +23415,33 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string; + created?: string | null; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ key?: string; /** * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -23828,7 +23450,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -23915,14 +23537,14 @@ export interface operations { * Format: uuid * @description The UUID the token pool this balance entry applies to */ - pool?: string; + pool?: string | null; /** @description The index of the token within the pool that this balance applies to */ tokenIndex?: string; /** * Format: date-time * @description The last time the balance was updated by applying a transfer event */ - updated?: string; + updated?: string | null; /** @description The URI of the token this balance entry applies to */ uri?: string; }[]; @@ -23952,15 +23574,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ amount?: string; /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -23977,16 +23597,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -23999,7 +23619,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -24008,12 +23628,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -24033,7 +23653,7 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description The name or UUID of a token pool */ pool?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -24059,14 +23679,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -24075,24 +23695,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -24132,14 +23752,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -24148,24 +23768,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -24251,15 +23871,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ amount?: string; /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -24276,16 +23894,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -24298,7 +23916,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -24307,12 +23925,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -24332,7 +23950,7 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description The name or UUID of a token pool */ pool?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -24358,14 +23976,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -24374,24 +23992,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -24431,14 +24049,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -24447,24 +24065,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -24576,7 +24194,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24585,9 +24203,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -24599,7 +24215,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24613,9 +24229,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -24672,13 +24288,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Input only field, with token connector specific configuration of the pool, such as an existing Ethereum address and block number to used to index the pool. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ connector?: string; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -24689,12 +24303,12 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ key?: string; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -24727,7 +24341,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24736,9 +24350,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -24750,7 +24362,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24764,9 +24376,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -24812,7 +24424,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24821,9 +24433,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -24835,7 +24445,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24849,9 +24459,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -24922,7 +24532,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24931,9 +24541,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -24945,7 +24553,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24959,9 +24567,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -25052,7 +24660,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ @@ -25076,7 +24684,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -25085,9 +24693,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -25099,7 +24705,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -25113,9 +24719,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -25161,7 +24767,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -25170,9 +24776,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -25184,7 +24788,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -25198,9 +24802,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -25316,14 +24920,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -25332,24 +24936,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25400,15 +25004,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ amount?: string; /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -25425,16 +25027,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -25447,7 +25049,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -25456,12 +25058,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -25481,7 +25083,7 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description The name or UUID of a token pool */ pool?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25507,14 +25109,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -25523,24 +25125,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25580,14 +25182,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -25596,24 +25198,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25678,14 +25280,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -25694,24 +25296,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25797,7 +25399,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -25876,7 +25478,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -25932,22 +25534,18 @@ export interface operations { */ id?: string; /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { - [key: string]: unknown; - }; + info?: any; /** * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string; + listener?: string | null; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ namespace?: string; /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ protocolId?: string; /** @description The blockchain plugin or token service that detected the event */ @@ -25956,7 +25554,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string; + timestamp?: string | null; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -26008,7 +25606,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -26017,29 +25615,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -26049,7 +25643,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -26095,9 +25689,7 @@ export interface operations { */ id?: string; /** @description Output details for this entry */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description The status of the detail record. Cases where an event is required for completion, but has not arrived yet are marked with a 'pending' record */ status?: string; /** @description A sub-type, such as an operation type, or an event type */ @@ -26106,7 +25698,7 @@ export interface operations { * Format: date-time * @description The time relevant to when the record was updated, such as the time an event was created, or the last update time of an operation */ - timestamp?: string; + timestamp?: string | null; /** @description The type of the transaction status detail record */ type?: string; }[]; @@ -26172,17 +25764,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string; + created?: string | null; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string; + identity?: string | null; /** @description The namespace of the verifier */ namespace?: string; /** @@ -26231,17 +25823,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string; + created?: string | null; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string; + identity?: string | null; /** @description The namespace of the verifier */ namespace?: string; /** @@ -26275,7 +25867,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @@ -26324,7 +25916,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @@ -26475,7 +26067,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26491,17 +26083,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26511,11 +26103,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -26525,7 +26115,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -26576,7 +26166,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26592,17 +26182,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26612,11 +26202,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -26626,7 +26214,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -26708,7 +26296,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26724,17 +26312,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26744,11 +26332,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -26758,7 +26344,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -26796,7 +26382,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26812,17 +26398,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26832,11 +26418,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -26846,7 +26430,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -26871,11 +26455,9 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; responses: { @@ -26890,7 +26472,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26906,17 +26488,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26926,11 +26508,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -26940,7 +26520,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -26955,7 +26535,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26971,17 +26551,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26991,11 +26571,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -27005,7 +26583,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -27077,7 +26655,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -27093,17 +26671,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -27113,11 +26691,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -27127,7 +26703,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -27152,7 +26728,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description A description of the identity. Part of the updatable profile information of an identity */ @@ -27164,9 +26740,7 @@ export interface operations { /** @description On input the parent can be specified directly as the UUID of and existing identity, or as a DID to resolve to that identity, or an organization name. The parent must already have been registered, and its blockchain signing key must be available to the local node to sign the verification */ parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** @description The type of the identity */ type?: string; }; @@ -27184,7 +26758,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -27200,17 +26774,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -27220,11 +26794,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -27234,7 +26806,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -27249,7 +26821,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -27265,17 +26837,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -27285,11 +26857,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -27299,7 +26869,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -27337,7 +26907,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -27353,17 +26923,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -27373,11 +26943,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -27387,7 +26955,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -27412,11 +26980,9 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; responses: { @@ -27431,7 +26997,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -27447,17 +27013,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -27467,11 +27033,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -27481,7 +27045,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -27496,7 +27060,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string; + created?: string | null; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -27512,17 +27076,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string; + claim?: string | null; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string; + update?: string | null; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string; + verification?: string | null; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -27532,11 +27096,9 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string; + parent?: string | null; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ - profile?: { - [key: string]: unknown; - }; + profile?: any; /** * @description The type of the identity * @enum {string} @@ -27546,7 +27108,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string; + updated?: string | null; }; }; }; @@ -27602,12 +27164,12 @@ export interface operations { * Format: byte * @description The context the next-pin applies to - the hash of the privacy group-hash + topic. The group-hash is only known to the participants (can itself contain a salt in the group-name). This context is combined with the member and nonce to determine the final hash that is written on-chain */ - context?: string; + context?: string | null; /** * Format: byte * @description The unique masked pin string */ - hash?: string; + hash?: string | null; /** @description The member of the privacy group the next-pin applies to */ identity?: string; /** @description The namespace of the next-pin */ @@ -27686,7 +27248,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -27695,29 +27257,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -27727,7 +27285,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -27768,7 +27326,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Additional detailed information about an operation provided by the connector */ detail?: unknown; /** @description Any error reported back from the plugin for this operation */ @@ -27779,29 +27337,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -27811,7 +27365,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -27836,11 +27390,9 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": { - [key: string]: unknown; - }; + "application/json": any; }; }; responses: { @@ -27855,7 +27407,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -27864,29 +27416,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -27896,7 +27444,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }; }; }; @@ -27958,24 +27506,24 @@ export interface operations { * Format: uuid * @description The UUID of the batch of messages this pin is part of */ - batch?: string; + batch?: string | null; /** * Format: byte * @description The manifest hash batch of messages this pin is part of */ - batchHash?: string; + batchHash?: string | null; /** * Format: date-time * @description The time the FireFly node created the pin */ - created?: string; + created?: string | null; /** @description Once true, this pin has been processed and will not be processed again */ dispatched?: boolean; /** * Format: byte * @description The hash represents a topic within a message in the batch. If a message has multiple topics, then multiple pins are created. If the message is private, the hash is masked for privacy */ - hash?: string; + hash?: string | null; /** * Format: int64 * @description The index of this pin within the batch. One pin is created for each topic, of each message in the batch @@ -28013,14 +27561,14 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** * Format: uuid * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified */ - batch?: string; + batch?: string | null; /** * Format: int64 * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified @@ -28041,7 +27589,7 @@ export interface operations { * Format: uuid * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified */ - batch?: string; + batch?: string | null; /** * Format: int64 * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified @@ -28097,8 +27645,8 @@ export interface operations { version?: number; }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; - }; + location?: any; + } | null; /** @description Previously-terminated FireFly smart contracts */ terminated?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ @@ -28115,9 +27663,9 @@ export interface operations { version?: number; }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; - }; + } | null; /** @description Whether multi-party mode is enabled for this namespace */ enabled?: boolean; }; @@ -28127,14 +27675,14 @@ export interface operations { * Format: date-time * @description The time the namespace was created */ - created?: string; + created?: string | null; /** @description A description of the namespace */ description?: string; /** @description The local namespace name */ name?: string; /** @description The shared namespace name within the multiparty network */ networkName?: string; - }; + } | null; /** @description Details of the local node */ node?: { /** @@ -28146,7 +27694,7 @@ export interface operations { name?: string; /** @description Whether the node has been successfully registered */ registered?: boolean; - }; + } | null; /** @description Details of the root organization identity registered for this namespace on the local node */ org?: { /** @description The DID of the organization identity, if registered */ @@ -28170,7 +27718,7 @@ export interface operations { /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ value?: string; }[]; - }; + } | null; /** @description Information about plugins configured on this namespace */ plugins?: { /** @description The blockchain plugins on this namespace */ @@ -28289,19 +27837,19 @@ export interface operations { * Format: uuid * @description If a flush is in progress, this is the UUID of the batch being flushed */ - flushing?: string; + flushing?: string | null; /** @description The last error received by this batch processor while flushing */ lastFlushError?: string; /** * Format: date-time * @description The time of the last flush */ - lastFlushErrorTime?: string; + lastFlushErrorTime?: string | null; /** * Format: date-time * @description The last time a flush was performed */ - lastFlushStartTime?: string; + lastFlushStartTime?: string | null; /** * Format: int64 * @description The total count of batches flushed by this processor since it started @@ -28362,10 +27910,10 @@ export interface operations { version?: number; }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; /** @description The status of the contract listener. One of 'syncing', 'synced', or 'unknown' */ status?: string; - }; + } | null; /** @description Previously-terminated FireFly smart contracts */ terminated?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ @@ -28382,9 +27930,9 @@ export interface operations { version?: number; }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ - location?: unknown; + location?: any; }[]; - }; + } | null; /** @description Whether multi-party mode is enabled for this namespace */ enabled?: boolean; /** @description Details of the local node */ @@ -28393,7 +27941,7 @@ export interface operations { * Format: uuid * @description The ID of the pending message that broadcast the identity claim to the network */ - pendingRegistrationMessageId?: string; + pendingRegistrationMessageId?: string | null; /** @description The status of the node registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ status?: string; }; @@ -28403,7 +27951,7 @@ export interface operations { * Format: uuid * @description The ID of the pending message that broadcast the identity claim to the network */ - pendingRegistrationMessageId?: string; + pendingRegistrationMessageId?: string | null; /** @description The status of the organization registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ status?: string; }; @@ -28468,7 +28016,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string; + created?: string | null; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -28519,17 +28067,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -28541,7 +28087,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -28565,11 +28111,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -28592,7 +28136,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -28600,7 +28144,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -28622,7 +28166,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Server-side filter to apply to events */ @@ -28668,17 +28212,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -28690,7 +28232,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -28714,11 +28256,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -28741,7 +28281,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -28760,7 +28300,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string; + created?: string | null; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -28811,17 +28351,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -28833,7 +28371,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -28857,11 +28395,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -28884,7 +28420,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -28892,7 +28428,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string; + updated?: string | null; }; }; }; @@ -28914,7 +28450,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Server-side filter to apply to events */ @@ -28960,17 +28496,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -28982,7 +28516,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -29006,11 +28540,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -29033,7 +28565,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -29052,7 +28584,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string; + created?: string | null; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -29103,17 +28635,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -29125,7 +28655,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -29149,11 +28679,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -29176,7 +28704,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -29184,7 +28712,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string; + updated?: string | null; }; }; }; @@ -29225,7 +28753,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string; + created?: string | null; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -29276,17 +28804,15 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean; + batch?: boolean | null; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string; + batchTimeout?: string | null; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string; + firstEvent?: string | null; /** @description Webhooks only: Static headers to set on the webhook request */ - headers?: { - [key: string]: string; - }; + headers?: any; /** @description Webhooks only: a set of options for HTTP */ httpOptions?: { /** @description The maximum amount of time that a connection is allowed to remain with no data transmitted. */ @@ -29298,7 +28824,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string; + proxyURL?: string | null; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -29322,11 +28848,9 @@ export interface operations { /** @description Webhooks only: HTTP method to invoke. Default=POST */ method?: string; /** @description Webhooks only: Static query params to set on the webhook request */ - query?: { - [key: string]: string; - }; + query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number; + readAhead?: number | null; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -29349,7 +28873,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean; + withData?: boolean | null; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -29357,7 +28881,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string; + updated?: string | null; }; }; }; @@ -29460,12 +28984,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string; + correlator?: string | null; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -29477,7 +29001,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string; + reference?: string | null; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -29489,7 +29013,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string; + tx?: string | null; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -29598,7 +29122,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this balance entry applies to */ - pool?: string; + pool?: string | null; }[]; }; }; @@ -29680,35 +29204,33 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string; + created?: string | null; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ key?: string; /** * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -29717,7 +29239,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -29756,15 +29278,13 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Whether this record grants permission for an operator to perform actions on the token balance (true), or revokes permission (false) */ approved?: boolean; /** @description Input only field, with token connector specific configuration of the approval. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ @@ -29779,16 +29299,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -29801,7 +29321,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -29810,12 +29330,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -29835,14 +29355,14 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description The blockchain identity that is granted the approval */ operator?: string; /** * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string; + pool?: string | null; }; }; }; @@ -29862,35 +29382,33 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string; + created?: string | null; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ key?: string; /** * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -29899,7 +29417,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -29932,35 +29450,33 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string; + created?: string | null; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ key?: string; /** * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -29969,7 +29485,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -30053,14 +29569,14 @@ export interface operations { * Format: uuid * @description The UUID the token pool this balance entry applies to */ - pool?: string; + pool?: string | null; /** @description The index of the token within the pool that this balance applies to */ tokenIndex?: string; /** * Format: date-time * @description The last time the balance was updated by applying a transfer event */ - updated?: string; + updated?: string | null; /** @description The URI of the token this balance entry applies to */ uri?: string; }[]; @@ -30087,15 +29603,13 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ amount?: string; /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -30112,16 +29626,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -30134,7 +29648,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -30143,12 +29657,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -30168,7 +29682,7 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description The name or UUID of a token pool */ pool?: string; /** @description The index of the token within the pool that this transfer applies to */ @@ -30192,14 +29706,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -30208,24 +29722,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -30265,14 +29779,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -30281,24 +29795,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -30378,15 +29892,13 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ amount?: string; /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ idempotencyKey?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -30401,16 +29913,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -30423,7 +29935,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -30432,12 +29944,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -30457,7 +29969,7 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description The name or UUID of a token pool */ pool?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -30483,14 +29995,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -30499,24 +30011,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -30556,14 +30068,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -30572,24 +30084,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -30698,7 +30210,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30707,9 +30219,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -30721,7 +30231,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30735,9 +30245,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -30791,13 +30301,11 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description Input only field, with token connector specific configuration of the pool, such as an existing Ethereum address and block number to used to index the pool. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description The name of the token connector, as specified in the FireFly core configuration file that is responsible for the token pool. Required on input when multiple token connectors are configured */ connector?: string; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -30808,12 +30316,12 @@ export interface operations { * Format: uuid * @description The UUID of the FireFly interface */ - id?: string; + id?: string | null; /** @description The name of the FireFly interface */ name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** @description The signing key used to create the token pool. On input for token connectors that support on-chain deployment of new tokens (vs. only index existing ones) this determines the signing key used to create the token on-chain */ key?: string; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -30846,7 +30354,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30855,9 +30363,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -30869,7 +30375,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30883,9 +30389,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -30931,7 +30437,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30940,9 +30446,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -30954,7 +30458,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30968,9 +30472,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -31039,7 +30543,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -31048,9 +30552,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -31062,7 +30564,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -31076,9 +30578,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -31165,7 +30667,7 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description An optional name to be used for publishing this definition to the multiparty network, which may differ from the local name */ @@ -31189,7 +30691,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -31198,9 +30700,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -31212,7 +30712,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -31226,9 +30726,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -31274,7 +30774,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string; + created?: string | null; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -31283,9 +30783,7 @@ export interface operations { */ id?: string; /** @description Token connector specific information about the pool. See your chosen token connector documentation for details */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description A reference to an existing FFI, containing pre-registered type information for the token contract */ interface?: { /** @@ -31297,7 +30795,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - }; + } | null; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -31311,9 +30809,9 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string; + message?: string | null; /** @description The method definitions resolved by the token connector to be used by each token operation */ - methods?: unknown; + methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ name?: string; /** @description The namespace for the token pool */ @@ -31426,14 +30924,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -31442,24 +30940,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31507,15 +31005,13 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The amount for the transfer. For non-fungible tokens will always be 1. For fungible tokens, the number of decimals for the token pool should be considered when inputting the amount. For example, with 18 decimals a fractional balance of 10.234 will be specified as 10,234,000,000,000,000,000 */ amount?: string; /** @description Input only field, with token connector specific configuration of the transfer. See your chosen token connector documentation for details */ - config?: { - [key: string]: unknown; - }; + config?: any; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description An optional identifier to allow idempotent submission of requests. Stored on the transaction uniquely within a namespace */ @@ -31532,16 +31028,16 @@ export interface operations { name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - }; + } | null; /** * Format: uuid * @description The UUID of the referenced data resource */ - id?: string; + id?: string | null; /** @description The data validator type to use for in-line data */ validator?: string; /** @description The in-line value for the data. Can be any JSON type - object, array, string, number or boolean */ - value?: unknown; + value?: any; }[]; /** @description Allows you to specify details of the private group of recipients in-line in the message. Alternative to using the header.group to specify the hash of a group that has been previously resolved */ group?: { @@ -31554,7 +31050,7 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - }; + } | null; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -31563,12 +31059,12 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string; + cid?: string | null; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string; + group?: string | null; /** @description The on-chain signing key used to sign the transaction */ key?: string; /** @description The message tag indicates the purpose of the message to the applications that process it */ @@ -31588,7 +31084,7 @@ export interface operations { }; /** @description An optional unique identifier for a message. Cannot be duplicated within a namespace, thus allowing idempotent submission of messages to the API. Local only - not transferred when the message is sent to other members of the network */ idempotencyKey?: string; - }; + } | null; /** @description The name or UUID of a token pool */ pool?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31614,14 +31110,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -31630,24 +31126,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31687,14 +31183,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -31703,24 +31199,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31783,14 +31279,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string; + blockchainEvent?: string | null; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string; + created?: string | null; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -31799,24 +31295,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string; + localId?: string | null; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string; + message?: string | null; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string; + messageHash?: string | null; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string; + pool?: string | null; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31899,7 +31395,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -31976,7 +31472,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string; + created?: string | null; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -32030,22 +31526,18 @@ export interface operations { */ id?: string; /** @description Detailed blockchain specific information about the event, as generated by the blockchain connector */ - info?: { - [key: string]: unknown; - }; + info?: any; /** * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string; + listener?: string | null; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ namespace?: string; /** @description The data output by the event, parsed to JSON according to the interface of the smart contract */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description An alphanumerically sortable string that represents this event uniquely on the blockchain (convention for plugins is zero-padded values BLOCKNUMBER/TXN_INDEX/EVENT_INDEX) */ protocolId?: string; /** @description The blockchain plugin or token service that detected the event */ @@ -32054,7 +31546,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string; + timestamp?: string | null; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -32104,7 +31596,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string; + created?: string | null; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -32113,29 +31605,25 @@ export interface operations { */ id?: string; /** @description The input to this operation */ - input?: { - [key: string]: unknown; - }; + input?: any; /** @description The namespace of the operation */ namespace?: string; /** @description Any output reported back from the plugin for this operation */ - output?: { - [key: string]: unknown; - }; + output?: any; /** @description The plugin responsible for performing the operation */ plugin?: string; /** * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string; + retry?: string | null; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string; + tx?: string | null; /** * @description The type of the operation * @enum {string} @@ -32145,7 +31633,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string; + updated?: string | null; }[]; }; }; @@ -32189,9 +31677,7 @@ export interface operations { */ id?: string; /** @description Output details for this entry */ - info?: { - [key: string]: unknown; - }; + info?: any; /** @description The status of the detail record. Cases where an event is required for completion, but has not arrived yet are marked with a 'pending' record */ status?: string; /** @description A sub-type, such as an operation type, or an event type */ @@ -32200,7 +31686,7 @@ export interface operations { * Format: date-time * @description The time relevant to when the record was updated, such as the time an event was created, or the last update time of an operation */ - timestamp?: string; + timestamp?: string | null; /** @description The type of the transaction status detail record */ type?: string; }[]; @@ -32263,17 +31749,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string; + created?: string | null; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string; + identity?: string | null; /** @description The namespace of the verifier */ namespace?: string; /** @@ -32320,17 +31806,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string; + created?: string | null; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string; + hash?: string | null; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string; + identity?: string | null; /** @description The namespace of the verifier */ namespace?: string; /** @@ -32361,7 +31847,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @@ -32473,7 +31959,7 @@ export interface operations { * Format: date-time * @description The time the subscription started (reset on dynamic namespace reload) */ - startTime?: string; + startTime?: string | null; }[]; /** @description The user agent of the connected client (if available) */ userAgent?: string; From d009fa30d215d617d7139cbfc678286bac89dca5 Mon Sep 17 00:00:00 2001 From: Andrew Richardson Date: Thu, 1 May 2025 12:30:50 -0400 Subject: [PATCH 6/7] More transforms to avoid null and unknown Signed-off-by: Andrew Richardson --- lib/schema.ts | 2218 ++++++++++++++++++++-------------------- scripts/parseSchema.ts | 17 +- 2 files changed, 1116 insertions(+), 1119 deletions(-) diff --git a/lib/schema.ts b/lib/schema.ts index 3ef179b..02f3a7a 100644 --- a/lib/schema.ts +++ b/lib/schema.ts @@ -3302,14 +3302,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3401,14 +3401,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3452,14 +3452,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3526,14 +3526,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3626,14 +3626,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3677,14 +3677,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -3782,7 +3782,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -3814,7 +3814,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -3840,7 +3840,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -3856,7 +3856,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -4012,7 +4012,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -4032,14 +4032,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -4049,7 +4049,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -4064,7 +4064,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -4084,14 +4084,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -4101,7 +4101,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -4178,7 +4178,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -4194,7 +4194,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -4212,7 +4212,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -4224,7 +4224,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -4246,7 +4246,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -4257,7 +4257,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -4335,7 +4335,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -4351,7 +4351,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -4369,7 +4369,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -4381,7 +4381,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -4403,7 +4403,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -4414,7 +4414,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -4477,7 +4477,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -4509,7 +4509,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -4535,7 +4535,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -4551,7 +4551,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -4608,7 +4608,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -4640,7 +4640,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -4666,7 +4666,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -4682,7 +4682,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -4836,22 +4836,22 @@ export interface operations { * Format: date-time * @description The time when the batch was confirmed */ - confirmed?: string | null; + confirmed?: string; /** * Format: date-time * @description The time the batch was sealed */ - created?: string | null; + created?: string; /** * Format: byte * @description The privacy group the batch is sent to, for private batches */ - group?: string | null; + group?: string; /** * Format: byte * @description The hash of the manifest of the batch */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the batch @@ -4867,7 +4867,7 @@ export interface operations { * Format: uuid * @description The UUID of the node that generated the batch */ - node?: string | null; + node?: string; /** @description The FireFly transaction associated with this batch */ tx?: { /** @@ -4922,22 +4922,22 @@ export interface operations { * Format: date-time * @description The time when the batch was confirmed */ - confirmed?: string | null; + confirmed?: string; /** * Format: date-time * @description The time the batch was sealed */ - created?: string | null; + created?: string; /** * Format: byte * @description The privacy group the batch is sent to, for private batches */ - group?: string | null; + group?: string; /** * Format: byte * @description The hash of the manifest of the batch */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the batch @@ -4953,7 +4953,7 @@ export interface operations { * Format: uuid * @description The UUID of the node that generated the batch */ - node?: string | null; + node?: string; /** @description The FireFly transaction associated with this batch */ tx?: { /** @@ -5077,7 +5077,7 @@ export interface operations { * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string | null; + listener?: string; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ @@ -5092,7 +5092,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string | null; + timestamp?: string; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -5149,7 +5149,7 @@ export interface operations { * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string | null; + listener?: string; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ @@ -5164,7 +5164,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string | null; + timestamp?: string; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -5225,7 +5225,7 @@ export interface operations { * Format: date-time * @description Starting timestamp for the bucket */ - timestamp?: string | null; + timestamp?: string; /** @description Array of separate counts for individual types of record within the bucket */ types?: { /** @description Count of entries of a given type within a bucket */ @@ -5287,7 +5287,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -5307,14 +5307,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -5324,7 +5324,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -5339,7 +5339,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -5359,14 +5359,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -5376,7 +5376,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -5445,7 +5445,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -5477,7 +5477,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -5503,7 +5503,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -5519,7 +5519,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -5667,7 +5667,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -5699,7 +5699,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -5725,7 +5725,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -5741,7 +5741,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -5824,7 +5824,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -5856,7 +5856,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -5882,7 +5882,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -5898,7 +5898,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6015,7 +6015,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -6047,7 +6047,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -6073,7 +6073,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -6089,7 +6089,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6181,7 +6181,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -6213,7 +6213,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -6239,7 +6239,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -6255,7 +6255,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6312,7 +6312,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -6344,7 +6344,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -6370,7 +6370,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -6386,7 +6386,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6478,7 +6478,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -6510,7 +6510,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -6536,7 +6536,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -6552,7 +6552,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -6747,7 +6747,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -6767,14 +6767,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -6784,7 +6784,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -6799,7 +6799,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -6819,14 +6819,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -6836,7 +6836,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -6908,7 +6908,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -6924,7 +6924,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -6942,7 +6942,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -6954,7 +6954,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -6976,7 +6976,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -6987,7 +6987,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -7109,7 +7109,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -7125,7 +7125,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -7143,7 +7143,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -7155,7 +7155,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -7177,7 +7177,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -7188,7 +7188,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -7235,7 +7235,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -7251,7 +7251,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -7269,7 +7269,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -7281,7 +7281,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -7303,7 +7303,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -7314,7 +7314,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -7627,7 +7627,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -7639,24 +7639,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -7741,7 +7741,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -7753,24 +7753,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -7823,7 +7823,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -7835,24 +7835,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -8033,7 +8033,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -8045,24 +8045,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -8170,19 +8170,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -8193,7 +8193,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -8202,22 +8202,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -8240,7 +8240,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -8269,7 +8269,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -8405,7 +8405,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -8417,24 +8417,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -8539,12 +8539,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string | null; + created?: string; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the datatype @@ -8554,7 +8554,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string | null; + message?: string; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -8621,12 +8621,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string | null; + created?: string; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the datatype @@ -8636,7 +8636,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string | null; + message?: string; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -8664,12 +8664,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string | null; + created?: string; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the datatype @@ -8679,7 +8679,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string | null; + message?: string; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -8732,12 +8732,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string | null; + created?: string; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the datatype @@ -8747,7 +8747,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string | null; + message?: string; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -8828,12 +8828,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string | null; + correlator?: string; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -8845,7 +8845,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string | null; + reference?: string; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -8857,7 +8857,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string | null; + tx?: string; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -8903,12 +8903,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string | null; + correlator?: string; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -8920,7 +8920,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string | null; + reference?: string; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -8932,7 +8932,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string | null; + tx?: string; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -8995,12 +8995,12 @@ export interface operations { * Format: date-time * @description The time when the group was first used to send a message in the network */ - created?: string | null; + created?: string; /** * Format: byte * @description The identifier hash of this group. Derived from the name and group members */ - hash?: string | null; + hash?: string; /** @description The local namespace of the group */ localNamespace?: string; /** @description The list of members in this privacy group */ @@ -9011,13 +9011,13 @@ export interface operations { * Format: uuid * @description The UUID of the node that receives a copy of the off-chain message for the identity */ - node?: string | null; + node?: string; }[]; /** * Format: uuid * @description The message used to broadcast this group privately to the members */ - message?: string | null; + message?: string; /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ name?: string; /** @description The namespace of the group within the multiparty network */ @@ -9059,12 +9059,12 @@ export interface operations { * Format: date-time * @description The time when the group was first used to send a message in the network */ - created?: string | null; + created?: string; /** * Format: byte * @description The identifier hash of this group. Derived from the name and group members */ - hash?: string | null; + hash?: string; /** @description The local namespace of the group */ localNamespace?: string; /** @description The list of members in this privacy group */ @@ -9075,13 +9075,13 @@ export interface operations { * Format: uuid * @description The UUID of the node that receives a copy of the off-chain message for the identity */ - node?: string | null; + node?: string; }[]; /** * Format: uuid * @description The message used to broadcast this group privately to the members */ - message?: string | null; + message?: string; /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ name?: string; /** @description The namespace of the group within the multiparty network */ @@ -9159,7 +9159,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9175,17 +9175,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9195,7 +9195,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -9207,7 +9207,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -9272,7 +9272,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9288,17 +9288,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9308,7 +9308,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -9320,7 +9320,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -9335,7 +9335,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9351,17 +9351,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9371,7 +9371,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -9383,7 +9383,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -9424,7 +9424,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9440,17 +9440,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9460,7 +9460,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -9472,7 +9472,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -9522,7 +9522,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9538,17 +9538,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9558,7 +9558,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -9570,7 +9570,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -9585,7 +9585,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -9601,17 +9601,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -9621,7 +9621,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -9633,7 +9633,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -9748,17 +9748,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string | null; + created?: string; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string | null; + identity?: string; /** @description The namespace of the verifier */ namespace?: string; /** @@ -9861,19 +9861,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -9884,7 +9884,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -9893,22 +9893,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -9931,7 +9931,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -9960,7 +9960,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }[]; }; }; @@ -10001,12 +10001,12 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ data?: { /** @description An optional in-line hash reference to a previously uploaded binary data blob */ @@ -10015,7 +10015,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -10027,19 +10027,19 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** @description The optional datatype to use for validation of the in-line data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10061,12 +10061,12 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - } | null; + }; /** * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10075,22 +10075,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10113,7 +10113,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10142,7 +10142,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -10182,7 +10182,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -10194,24 +10194,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -10291,12 +10291,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string | null; + correlator?: string; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -10308,7 +10308,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string | null; + reference?: string; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -10320,7 +10320,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string | null; + tx?: string; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -10365,7 +10365,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -10469,19 +10469,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10492,7 +10492,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10501,17 +10501,17 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10534,7 +10534,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10563,7 +10563,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -10578,19 +10578,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10601,7 +10601,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10610,17 +10610,17 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10643,7 +10643,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10672,7 +10672,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -10779,19 +10779,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10802,7 +10802,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10811,22 +10811,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10849,7 +10849,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10878,7 +10878,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -10893,19 +10893,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -10916,7 +10916,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -10925,22 +10925,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -10963,7 +10963,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -10992,7 +10992,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -11096,12 +11096,12 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ data?: { /** @description An optional in-line hash reference to a previously uploaded binary data blob */ @@ -11110,7 +11110,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -11122,19 +11122,19 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** @description The optional datatype to use for validation of the in-line data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -11156,12 +11156,12 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - } | null; + }; /** * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -11170,22 +11170,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -11208,7 +11208,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -11237,7 +11237,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -11275,7 +11275,7 @@ export interface operations { * Format: date-time * @description The time the namespace was created */ - created?: string | null; + created?: string; /** @description A description of the namespace */ description?: string; /** @description Set to a non-empty string in the case that the namespace is currently failing to initialize */ @@ -11323,7 +11323,7 @@ export interface operations { * Format: date-time * @description The time the namespace was created */ - created?: string | null; + created?: string; /** @description A description of the namespace */ description?: string; /** @description The local namespace name */ @@ -11402,14 +11402,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11504,14 +11504,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11555,14 +11555,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11631,14 +11631,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11733,14 +11733,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11784,14 +11784,14 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description If this API is tied to an individual instance of a smart contract, this field can include a blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** * Format: uuid * @description The UUID of the broadcast message that was used to publish this API to the network */ - message?: string | null; + message?: string; /** @description The name that is used in the URL to access the API */ name?: string; /** @description The namespace of the contract API */ @@ -11893,7 +11893,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -11925,7 +11925,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -11951,7 +11951,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -11967,7 +11967,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -12169,7 +12169,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -12189,14 +12189,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -12206,7 +12206,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -12221,7 +12221,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -12241,14 +12241,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -12258,7 +12258,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -12337,7 +12337,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -12353,7 +12353,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -12371,7 +12371,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -12383,7 +12383,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -12405,7 +12405,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -12416,7 +12416,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -12541,7 +12541,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -12557,7 +12557,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -12575,7 +12575,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -12587,7 +12587,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -12609,7 +12609,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -12620,7 +12620,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -12685,7 +12685,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -12717,7 +12717,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -12743,7 +12743,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -12759,7 +12759,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -12816,7 +12816,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -12848,7 +12848,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -12874,7 +12874,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -12890,7 +12890,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -13160,22 +13160,22 @@ export interface operations { * Format: date-time * @description The time when the batch was confirmed */ - confirmed?: string | null; + confirmed?: string; /** * Format: date-time * @description The time the batch was sealed */ - created?: string | null; + created?: string; /** * Format: byte * @description The privacy group the batch is sent to, for private batches */ - group?: string | null; + group?: string; /** * Format: byte * @description The hash of the manifest of the batch */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the batch @@ -13191,7 +13191,7 @@ export interface operations { * Format: uuid * @description The UUID of the node that generated the batch */ - node?: string | null; + node?: string; /** @description The FireFly transaction associated with this batch */ tx?: { /** @@ -13248,22 +13248,22 @@ export interface operations { * Format: date-time * @description The time when the batch was confirmed */ - confirmed?: string | null; + confirmed?: string; /** * Format: date-time * @description The time the batch was sealed */ - created?: string | null; + created?: string; /** * Format: byte * @description The privacy group the batch is sent to, for private batches */ - group?: string | null; + group?: string; /** * Format: byte * @description The hash of the manifest of the batch */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the batch @@ -13279,7 +13279,7 @@ export interface operations { * Format: uuid * @description The UUID of the node that generated the batch */ - node?: string | null; + node?: string; /** @description The FireFly transaction associated with this batch */ tx?: { /** @@ -13408,7 +13408,7 @@ export interface operations { * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string | null; + listener?: string; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ @@ -13423,7 +13423,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string | null; + timestamp?: string; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -13482,7 +13482,7 @@ export interface operations { * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string | null; + listener?: string; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ @@ -13497,7 +13497,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string | null; + timestamp?: string; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -13560,7 +13560,7 @@ export interface operations { * Format: date-time * @description Starting timestamp for the bucket */ - timestamp?: string | null; + timestamp?: string; /** @description Array of separate counts for individual types of record within the bucket */ types?: { /** @description Count of entries of a given type within a bucket */ @@ -13625,7 +13625,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -13645,14 +13645,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -13662,7 +13662,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -13677,7 +13677,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -13697,14 +13697,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -13714,7 +13714,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -13786,7 +13786,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -13818,7 +13818,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -13844,7 +13844,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -13860,7 +13860,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14011,7 +14011,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14043,7 +14043,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14069,7 +14069,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -14085,7 +14085,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14170,7 +14170,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14202,7 +14202,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14228,7 +14228,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -14244,7 +14244,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14365,7 +14365,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14397,7 +14397,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14423,7 +14423,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -14439,7 +14439,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14533,7 +14533,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14565,7 +14565,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14591,7 +14591,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -14607,7 +14607,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14664,7 +14664,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14696,7 +14696,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14722,7 +14722,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -14738,7 +14738,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -14833,7 +14833,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this error is part of */ - interface?: string | null; + interface?: string; /** @description The name of the error */ name?: string; /** @description The namespace of the FFI */ @@ -14865,7 +14865,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this event is part of */ - interface?: string | null; + interface?: string; /** @description The name of the event */ name?: string; /** @description The namespace of the FFI */ @@ -14891,7 +14891,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this FFI to the network */ - message?: string | null; + message?: string; /** @description An array of smart contract method definitions */ methods?: { /** @description A description of the smart contract method */ @@ -14907,7 +14907,7 @@ export interface operations { * Format: uuid * @description The UUID of the FFI smart contract definition that this method is part of */ - interface?: string | null; + interface?: string; /** @description The name of the method */ name?: string; /** @description The namespace of the FFI */ @@ -15105,7 +15105,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -15125,14 +15125,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -15142,7 +15142,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -15157,7 +15157,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -15177,14 +15177,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -15194,7 +15194,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -15269,7 +15269,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -15285,7 +15285,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -15303,7 +15303,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -15315,7 +15315,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -15337,7 +15337,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -15348,7 +15348,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -15473,7 +15473,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -15489,7 +15489,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -15507,7 +15507,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -15519,7 +15519,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -15541,7 +15541,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -15552,7 +15552,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -15601,7 +15601,7 @@ export interface operations { * Format: date-time * @description The creation time of the listener */ - created?: string | null; + created?: string; /** @description Deprecated: Please use 'event' in the array of 'filters' instead */ event?: { /** @description A description of the smart contract event */ @@ -15617,7 +15617,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A list of filters for the contract listener. Each filter is made up of an Event and an optional Location. Events matching these filters will always be emitted in the order determined by the blockchain. */ filters?: { /** @description The definition of the event, either provided in-line when creating the listener, or extracted from the referenced FFI when supplied */ @@ -15635,7 +15635,7 @@ export interface operations { /** @description FireFly uses an extended subset of JSON Schema to describe parameters, similar to OpenAPI/Swagger. Converters are available for native blockchain interface definitions / type systems - such as an Ethereum ABI. See the documentation for more detail */ schema?: any; }[]; - } | null; + }; /** @description A reference to an existing FFI, containing pre-registered type information for the event, used in combination with eventPath */ interface?: { /** @@ -15647,7 +15647,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; /** @description The stringified signature of the event and location, as computed by the blockchain plugin */ @@ -15669,7 +15669,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** @description Deprecated: Please use 'location' in the array of 'filters' instead */ location?: any; /** @description A descriptive name for the listener */ @@ -15680,7 +15680,7 @@ export interface operations { options?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors. Default is 'newest' */ firstEvent?: string; - } | null; + }; /** @description A concatenation of all the stringified signature of the event and location, as computed by the blockchain plugin */ signature?: string; /** @description A topic to set on the FireFly event that is emitted each time a blockchain event is detected from the blockchain. Setting this topic on a number of listeners allows applications to easily subscribe to all events they need */ @@ -16071,7 +16071,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16083,24 +16083,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -16188,7 +16188,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16200,24 +16200,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -16272,7 +16272,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16284,24 +16284,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -16488,7 +16488,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16500,24 +16500,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -16627,19 +16627,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -16650,7 +16650,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -16659,22 +16659,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -16697,7 +16697,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -16726,7 +16726,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -16866,7 +16866,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -16878,24 +16878,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -17005,12 +17005,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string | null; + created?: string; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the datatype @@ -17020,7 +17020,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string | null; + message?: string; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -17090,12 +17090,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string | null; + created?: string; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the datatype @@ -17105,7 +17105,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string | null; + message?: string; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -17133,12 +17133,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string | null; + created?: string; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the datatype @@ -17148,7 +17148,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string | null; + message?: string; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -17203,12 +17203,12 @@ export interface operations { * Format: date-time * @description The time the datatype was created */ - created?: string | null; + created?: string; /** * Format: byte * @description The hash of the value, such as the JSON schema. Allows all parties to be confident they have the exact same rules for verifying data created against a datatype */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the datatype @@ -17218,7 +17218,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message that was used to publish this datatype to the network */ - message?: string | null; + message?: string; /** @description The name of the datatype */ name?: string; /** @description The namespace of the datatype. Data resources can only be created referencing datatypes in the same namespace */ @@ -17302,12 +17302,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string | null; + correlator?: string; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -17319,7 +17319,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string | null; + reference?: string; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -17331,7 +17331,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string | null; + tx?: string; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -17379,12 +17379,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string | null; + correlator?: string; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -17396,7 +17396,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string | null; + reference?: string; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -17408,7 +17408,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string | null; + tx?: string; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -17474,12 +17474,12 @@ export interface operations { * Format: date-time * @description The time when the group was first used to send a message in the network */ - created?: string | null; + created?: string; /** * Format: byte * @description The identifier hash of this group. Derived from the name and group members */ - hash?: string | null; + hash?: string; /** @description The local namespace of the group */ localNamespace?: string; /** @description The list of members in this privacy group */ @@ -17490,13 +17490,13 @@ export interface operations { * Format: uuid * @description The UUID of the node that receives a copy of the off-chain message for the identity */ - node?: string | null; + node?: string; }[]; /** * Format: uuid * @description The message used to broadcast this group privately to the members */ - message?: string | null; + message?: string; /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ name?: string; /** @description The namespace of the group within the multiparty network */ @@ -17540,12 +17540,12 @@ export interface operations { * Format: date-time * @description The time when the group was first used to send a message in the network */ - created?: string | null; + created?: string; /** * Format: byte * @description The identifier hash of this group. Derived from the name and group members */ - hash?: string | null; + hash?: string; /** @description The local namespace of the group */ localNamespace?: string; /** @description The list of members in this privacy group */ @@ -17556,13 +17556,13 @@ export interface operations { * Format: uuid * @description The UUID of the node that receives a copy of the off-chain message for the identity */ - node?: string | null; + node?: string; }[]; /** * Format: uuid * @description The message used to broadcast this group privately to the members */ - message?: string | null; + message?: string; /** @description The optional name of the group, allowing multiple unique groups to exist with the same list of recipients */ name?: string; /** @description The namespace of the group within the multiparty network */ @@ -17643,7 +17643,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -17659,17 +17659,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -17679,7 +17679,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -17691,7 +17691,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -17759,7 +17759,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -17775,17 +17775,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -17795,7 +17795,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -17807,7 +17807,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -17822,7 +17822,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -17838,17 +17838,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -17858,7 +17858,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -17870,7 +17870,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -17913,7 +17913,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -17929,17 +17929,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -17949,7 +17949,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -17961,7 +17961,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -18013,7 +18013,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -18029,17 +18029,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -18049,7 +18049,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -18061,7 +18061,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -18076,7 +18076,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -18092,17 +18092,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -18112,7 +18112,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -18124,7 +18124,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -18243,17 +18243,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string | null; + created?: string; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string | null; + identity?: string; /** @description The namespace of the verifier */ namespace?: string; /** @@ -18359,19 +18359,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -18382,7 +18382,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -18391,22 +18391,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -18429,7 +18429,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -18458,7 +18458,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }[]; }; }; @@ -18501,12 +18501,12 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ data?: { /** @description An optional in-line hash reference to a previously uploaded binary data blob */ @@ -18515,7 +18515,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -18527,19 +18527,19 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** @description The optional datatype to use for validation of the in-line data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -18561,12 +18561,12 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - } | null; + }; /** * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -18575,22 +18575,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -18613,7 +18613,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -18642,7 +18642,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -18684,7 +18684,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -18696,24 +18696,24 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** * Format: date-time * @description The creation time of the data resource */ - created?: string | null; + created?: string; /** @description The optional datatype to use of validation of this data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the data resource. Derived from the value and the hash of any binary blob attachment */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the data resource @@ -18795,12 +18795,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string | null; + correlator?: string; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -18812,7 +18812,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string | null; + reference?: string; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -18824,7 +18824,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string | null; + tx?: string; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -18871,7 +18871,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -18995,19 +18995,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19018,7 +19018,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19027,22 +19027,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19065,7 +19065,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19094,7 +19094,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -19109,19 +19109,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19132,7 +19132,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19141,22 +19141,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19179,7 +19179,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19208,7 +19208,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -19318,19 +19318,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19341,7 +19341,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19350,22 +19350,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19388,7 +19388,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19417,7 +19417,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -19432,19 +19432,19 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description The list of data elements attached to the message */ data?: { /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19455,7 +19455,7 @@ export interface operations { * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19464,22 +19464,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19502,7 +19502,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19531,7 +19531,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -19638,12 +19638,12 @@ export interface operations { * Format: uuid * @description The UUID of the batch in which the message was pinned/transferred */ - batch?: string | null; + batch?: string; /** * Format: date-time * @description The timestamp of when the message was confirmed/rejected */ - confirmed?: string | null; + confirmed?: string; /** @description For input allows you to specify data in-line in the message, that will be turned into data attachments. For output when fetchdata is used on API calls, includes the in-line data payloads of all data attachments */ data?: { /** @description An optional in-line hash reference to a previously uploaded binary data blob */ @@ -19652,7 +19652,7 @@ export interface operations { * Format: byte * @description The hash of the binary blob data */ - hash?: string | null; + hash?: string; /** @description The name field from the metadata attached to the blob, commonly used as a path/filename, and indexed for search */ name?: string; /** @description If a name is specified, this field stores the '/' prefixed and separated path extracted from the full name */ @@ -19664,19 +19664,19 @@ export interface operations { * @description The size of the binary data */ size?: number; - } | null; + }; /** @description The optional datatype to use for validation of the in-line data */ datatype?: { /** @description The name of the datatype */ name?: string; /** @description The version of the datatype. Semantic versioning is encouraged, such as v1.0.1 */ version?: string; - } | null; + }; /** * Format: byte * @description The hash of the referenced data */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the referenced data resource @@ -19698,12 +19698,12 @@ export interface operations { }[]; /** @description Optional name for the group. Allows you to have multiple separate groups with the same list of participants */ name?: string; - } | null; + }; /** * Format: byte * @description The hash of the message. Derived from the header, which includes the data hash */ - hash?: string | null; + hash?: string; /** @description The message header contains all fields that are used to build the message hash */ header?: { /** @description The DID of identity of the submitter */ @@ -19712,22 +19712,22 @@ export interface operations { * Format: uuid * @description The correlation ID of the message. Set this when a message is a response to another message */ - cid?: string | null; + cid?: string; /** * Format: date-time * @description The creation time of the message */ - created?: string | null; + created?: string; /** * Format: byte * @description A single hash representing all data in the message. Derived from the array of data ids+hashes attached to this message */ - datahash?: string | null; + datahash?: string; /** * Format: byte * @description Private messages only - the identifier hash of the privacy group. Derived from the name and member list of the group */ - group?: string | null; + group?: string; /** * Format: uuid * @description The UUID of the message. Unique to each message @@ -19750,7 +19750,7 @@ export interface operations { id?: string; /** @description The type of the FireFly transaction */ type?: string; - } | null; + }; /** * @description The type of transaction used to order/deliver this message * @enum {string} @@ -19779,7 +19779,7 @@ export interface operations { * Format: uuid * @description The ID of the transaction used to order/deliver this message */ - txid?: string | null; + txid?: string; }; }; }; @@ -19960,7 +19960,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -19976,17 +19976,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -19996,7 +19996,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20008,7 +20008,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -20061,7 +20061,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20077,17 +20077,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20097,7 +20097,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20109,7 +20109,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -20194,7 +20194,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20210,17 +20210,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20230,7 +20230,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20242,7 +20242,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -20282,7 +20282,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20298,17 +20298,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20318,7 +20318,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20330,7 +20330,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -20375,7 +20375,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20391,17 +20391,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20411,7 +20411,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20423,7 +20423,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -20438,7 +20438,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20454,17 +20454,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20474,7 +20474,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20486,7 +20486,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -20561,7 +20561,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20577,17 +20577,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20597,7 +20597,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20609,7 +20609,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -20667,7 +20667,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20683,17 +20683,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20703,7 +20703,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20715,7 +20715,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -20730,7 +20730,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20746,17 +20746,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20766,7 +20766,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20778,7 +20778,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -20818,7 +20818,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20834,17 +20834,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20854,7 +20854,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20866,7 +20866,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -20911,7 +20911,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20927,17 +20927,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -20947,7 +20947,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -20959,7 +20959,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -20974,7 +20974,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -20990,17 +20990,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -21010,7 +21010,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -21022,7 +21022,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -21081,12 +21081,12 @@ export interface operations { * Format: byte * @description The context the next-pin applies to - the hash of the privacy group-hash + topic. The group-hash is only known to the participants (can itself contain a salt in the group-name). This context is combined with the member and nonce to determine the final hash that is written on-chain */ - context?: string | null; + context?: string; /** * Format: byte * @description The unique masked pin string */ - hash?: string | null; + hash?: string; /** @description The member of the privacy group the next-pin applies to */ identity?: string; /** @description The namespace of the next-pin */ @@ -21168,7 +21168,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -21188,14 +21188,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -21205,7 +21205,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -21248,9 +21248,9 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Additional detailed information about an operation provided by the connector */ - detail?: unknown; + detail?: any; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -21270,14 +21270,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -21287,7 +21287,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -21331,7 +21331,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -21351,14 +21351,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -21368,7 +21368,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -21433,24 +21433,24 @@ export interface operations { * Format: uuid * @description The UUID of the batch of messages this pin is part of */ - batch?: string | null; + batch?: string; /** * Format: byte * @description The manifest hash batch of messages this pin is part of */ - batchHash?: string | null; + batchHash?: string; /** * Format: date-time * @description The time the FireFly node created the pin */ - created?: string | null; + created?: string; /** @description Once true, this pin has been processed and will not be processed again */ dispatched?: boolean; /** * Format: byte * @description The hash represents a topic within a message in the batch. If a message has multiple topics, then multiple pins are created. If the message is private, the hash is masked for privacy */ - hash?: string | null; + hash?: string; /** * Format: int64 * @description The index of this pin within the batch. One pin is created for each topic, of each message in the batch @@ -21519,7 +21519,7 @@ export interface operations { * Format: uuid * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified */ - batch?: string | null; + batch?: string; /** * Format: int64 * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified @@ -21579,7 +21579,7 @@ export interface operations { }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; - } | null; + }; /** @description Previously-terminated FireFly smart contracts */ terminated?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ @@ -21598,7 +21598,7 @@ export interface operations { /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; }[]; - } | null; + }; /** @description Whether multi-party mode is enabled for this namespace */ enabled?: boolean; }; @@ -21608,14 +21608,14 @@ export interface operations { * Format: date-time * @description The time the namespace was created */ - created?: string | null; + created?: string; /** @description A description of the namespace */ description?: string; /** @description The local namespace name */ name?: string; /** @description The shared namespace name within the multiparty network */ networkName?: string; - } | null; + }; /** @description Details of the local node */ node?: { /** @@ -21627,7 +21627,7 @@ export interface operations { name?: string; /** @description Whether the node has been successfully registered */ registered?: boolean; - } | null; + }; /** @description Details of the root organization identity registered for this namespace on the local node */ org?: { /** @description The DID of the organization identity, if registered */ @@ -21651,7 +21651,7 @@ export interface operations { /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ value?: string; }[]; - } | null; + }; /** @description Information about plugins configured on this namespace */ plugins?: { /** @description The blockchain plugins on this namespace */ @@ -21773,19 +21773,19 @@ export interface operations { * Format: uuid * @description If a flush is in progress, this is the UUID of the batch being flushed */ - flushing?: string | null; + flushing?: string; /** @description The last error received by this batch processor while flushing */ lastFlushError?: string; /** * Format: date-time * @description The time of the last flush */ - lastFlushErrorTime?: string | null; + lastFlushErrorTime?: string; /** * Format: date-time * @description The last time a flush was performed */ - lastFlushStartTime?: string | null; + lastFlushStartTime?: string; /** * Format: int64 * @description The total count of batches flushed by this processor since it started @@ -21852,7 +21852,7 @@ export interface operations { location?: any; /** @description The status of the contract listener. One of 'syncing', 'synced', or 'unknown' */ status?: string; - } | null; + }; /** @description Previously-terminated FireFly smart contracts */ terminated?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ @@ -21871,7 +21871,7 @@ export interface operations { /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; }[]; - } | null; + }; /** @description Whether multi-party mode is enabled for this namespace */ enabled?: boolean; /** @description Details of the local node */ @@ -21880,7 +21880,7 @@ export interface operations { * Format: uuid * @description The ID of the pending message that broadcast the identity claim to the network */ - pendingRegistrationMessageId?: string | null; + pendingRegistrationMessageId?: string; /** @description The status of the node registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ status?: string; }; @@ -21890,7 +21890,7 @@ export interface operations { * Format: uuid * @description The ID of the pending message that broadcast the identity claim to the network */ - pendingRegistrationMessageId?: string | null; + pendingRegistrationMessageId?: string; /** @description The status of the organization registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ status?: string; }; @@ -21958,7 +21958,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string | null; + created?: string; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -22009,13 +22009,13 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean | null; + batch?: boolean; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string | null; + batchTimeout?: string; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string | null; + firstEvent?: string; /** @description Webhooks only: Static headers to set on the webhook request */ headers?: any; /** @description Webhooks only: a set of options for HTTP */ @@ -22029,7 +22029,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string | null; + proxyURL?: string; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22055,7 +22055,7 @@ export interface operations { /** @description Webhooks only: Static query params to set on the webhook request */ query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number | null; + readAhead?: number; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -22078,7 +22078,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean | null; + withData?: boolean; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -22086,7 +22086,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -22245,7 +22245,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string | null; + created?: string; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -22296,13 +22296,13 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean | null; + batch?: boolean; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string | null; + batchTimeout?: string; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string | null; + firstEvent?: string; /** @description Webhooks only: Static headers to set on the webhook request */ headers?: any; /** @description Webhooks only: a set of options for HTTP */ @@ -22316,7 +22316,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string | null; + proxyURL?: string; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22342,7 +22342,7 @@ export interface operations { /** @description Webhooks only: Static query params to set on the webhook request */ query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number | null; + readAhead?: number; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -22365,7 +22365,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean | null; + withData?: boolean; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -22373,7 +22373,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string | null; + updated?: string; }; }; }; @@ -22532,7 +22532,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string | null; + created?: string; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -22583,13 +22583,13 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean | null; + batch?: boolean; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string | null; + batchTimeout?: string; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string | null; + firstEvent?: string; /** @description Webhooks only: Static headers to set on the webhook request */ headers?: any; /** @description Webhooks only: a set of options for HTTP */ @@ -22603,7 +22603,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string | null; + proxyURL?: string; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22629,7 +22629,7 @@ export interface operations { /** @description Webhooks only: Static query params to set on the webhook request */ query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number | null; + readAhead?: number; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -22652,7 +22652,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean | null; + withData?: boolean; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -22660,7 +22660,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string | null; + updated?: string; }; }; }; @@ -22703,7 +22703,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string | null; + created?: string; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -22754,13 +22754,13 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean | null; + batch?: boolean; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string | null; + batchTimeout?: string; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string | null; + firstEvent?: string; /** @description Webhooks only: Static headers to set on the webhook request */ headers?: any; /** @description Webhooks only: a set of options for HTTP */ @@ -22774,7 +22774,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string | null; + proxyURL?: string; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -22800,7 +22800,7 @@ export interface operations { /** @description Webhooks only: Static query params to set on the webhook request */ query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number | null; + readAhead?: number; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -22823,7 +22823,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean | null; + withData?: boolean; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -22831,7 +22831,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string | null; + updated?: string; }; }; }; @@ -22938,12 +22938,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string | null; + correlator?: string; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -22955,7 +22955,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string | null; + reference?: string; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -22967,7 +22967,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string | null; + tx?: string; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -23081,7 +23081,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this balance entry applies to */ - pool?: string | null; + pool?: string; }[]; }; }; @@ -23166,14 +23166,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string | null; + created?: string; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ @@ -23182,17 +23182,17 @@ export interface operations { * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -23201,7 +23201,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -23347,14 +23347,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string | null; + created?: string; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ @@ -23363,17 +23363,17 @@ export interface operations { * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -23382,7 +23382,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -23415,14 +23415,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string | null; + created?: string; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ @@ -23431,17 +23431,17 @@ export interface operations { * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -23450,7 +23450,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -23537,14 +23537,14 @@ export interface operations { * Format: uuid * @description The UUID the token pool this balance entry applies to */ - pool?: string | null; + pool?: string; /** @description The index of the token within the pool that this balance applies to */ tokenIndex?: string; /** * Format: date-time * @description The last time the balance was updated by applying a transfer event */ - updated?: string | null; + updated?: string; /** @description The URI of the token this balance entry applies to */ uri?: string; }[]; @@ -23679,14 +23679,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -23695,24 +23695,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -23752,14 +23752,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -23768,24 +23768,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -23976,14 +23976,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -23992,24 +23992,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -24049,14 +24049,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -24065,24 +24065,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -24194,7 +24194,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24215,7 +24215,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24229,7 +24229,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -24341,7 +24341,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24362,7 +24362,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24376,7 +24376,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -24424,7 +24424,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24445,7 +24445,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24459,7 +24459,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -24532,7 +24532,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24553,7 +24553,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24567,7 +24567,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -24684,7 +24684,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24705,7 +24705,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24719,7 +24719,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -24767,7 +24767,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -24788,7 +24788,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -24802,7 +24802,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -24920,14 +24920,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -24936,24 +24936,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25109,14 +25109,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -25125,24 +25125,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25182,14 +25182,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -25198,24 +25198,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25280,14 +25280,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -25296,24 +25296,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -25399,7 +25399,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -25478,7 +25478,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -25539,7 +25539,7 @@ export interface operations { * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string | null; + listener?: string; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ @@ -25554,7 +25554,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string | null; + timestamp?: string; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -25606,7 +25606,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -25626,14 +25626,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -25643,7 +25643,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -25698,7 +25698,7 @@ export interface operations { * Format: date-time * @description The time relevant to when the record was updated, such as the time an event was created, or the last update time of an operation */ - timestamp?: string | null; + timestamp?: string; /** @description The type of the transaction status detail record */ type?: string; }[]; @@ -25764,17 +25764,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string | null; + created?: string; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string | null; + identity?: string; /** @description The namespace of the verifier */ namespace?: string; /** @@ -25823,17 +25823,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string | null; + created?: string; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string | null; + identity?: string; /** @description The namespace of the verifier */ namespace?: string; /** @@ -26067,7 +26067,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26083,17 +26083,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26103,7 +26103,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26115,7 +26115,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -26166,7 +26166,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26182,17 +26182,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26202,7 +26202,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26214,7 +26214,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; /** @description The verifiers, such as blockchain signing keys, that have been bound to this identity and can be used to prove data orignates from that identity */ verifiers?: { /** @@ -26296,7 +26296,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26312,17 +26312,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26332,7 +26332,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26344,7 +26344,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -26382,7 +26382,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26398,17 +26398,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26418,7 +26418,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26430,7 +26430,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -26472,7 +26472,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26488,17 +26488,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26508,7 +26508,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26520,7 +26520,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -26535,7 +26535,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26551,17 +26551,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26571,7 +26571,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26583,7 +26583,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -26655,7 +26655,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26671,17 +26671,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26691,7 +26691,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26703,7 +26703,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -26758,7 +26758,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26774,17 +26774,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26794,7 +26794,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26806,7 +26806,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -26821,7 +26821,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26837,17 +26837,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26857,7 +26857,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26869,7 +26869,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -26907,7 +26907,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -26923,17 +26923,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -26943,7 +26943,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -26955,7 +26955,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -26997,7 +26997,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -27013,17 +27013,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -27033,7 +27033,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -27045,7 +27045,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -27060,7 +27060,7 @@ export interface operations { * Format: date-time * @description The creation time of the identity */ - created?: string | null; + created?: string; /** @description A description of the identity. Part of the updatable profile information of an identity */ description?: string; /** @description The DID of the identity. Unique across namespaces within a FireFly network */ @@ -27076,17 +27076,17 @@ export interface operations { * Format: uuid * @description The UUID of claim message */ - claim?: string | null; + claim?: string; /** * Format: uuid * @description The UUID of the most recently applied update message. Unset if no updates have been confirmed */ - update?: string | null; + update?: string; /** * Format: uuid * @description The UUID of claim message. Unset for root organization identities */ - verification?: string | null; + verification?: string; }; /** @description The name of the identity. The name must be unique within the type and namespace */ name?: string; @@ -27096,7 +27096,7 @@ export interface operations { * Format: uuid * @description The UUID of the parent identity. Unset for root organization identities */ - parent?: string | null; + parent?: string; /** @description A set of metadata for the identity. Part of the updatable profile information of an identity */ profile?: any; /** @@ -27108,7 +27108,7 @@ export interface operations { * Format: date-time * @description The last update time of the identity profile */ - updated?: string | null; + updated?: string; }; }; }; @@ -27164,12 +27164,12 @@ export interface operations { * Format: byte * @description The context the next-pin applies to - the hash of the privacy group-hash + topic. The group-hash is only known to the participants (can itself contain a salt in the group-name). This context is combined with the member and nonce to determine the final hash that is written on-chain */ - context?: string | null; + context?: string; /** * Format: byte * @description The unique masked pin string */ - hash?: string | null; + hash?: string; /** @description The member of the privacy group the next-pin applies to */ identity?: string; /** @description The namespace of the next-pin */ @@ -27248,7 +27248,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -27268,14 +27268,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -27285,7 +27285,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -27326,9 +27326,9 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Additional detailed information about an operation provided by the connector */ - detail?: unknown; + detail?: any; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -27348,14 +27348,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -27365,7 +27365,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -27407,7 +27407,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -27427,14 +27427,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -27444,7 +27444,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }; }; }; @@ -27506,24 +27506,24 @@ export interface operations { * Format: uuid * @description The UUID of the batch of messages this pin is part of */ - batch?: string | null; + batch?: string; /** * Format: byte * @description The manifest hash batch of messages this pin is part of */ - batchHash?: string | null; + batchHash?: string; /** * Format: date-time * @description The time the FireFly node created the pin */ - created?: string | null; + created?: string; /** @description Once true, this pin has been processed and will not be processed again */ dispatched?: boolean; /** * Format: byte * @description The hash represents a topic within a message in the batch. If a message has multiple topics, then multiple pins are created. If the message is private, the hash is masked for privacy */ - hash?: string | null; + hash?: string; /** * Format: int64 * @description The index of this pin within the batch. One pin is created for each topic, of each message in the batch @@ -27589,7 +27589,7 @@ export interface operations { * Format: uuid * @description The ID of the batch to which the event aggregator should rewind. Either sequence or batch must be specified */ - batch?: string | null; + batch?: string; /** * Format: int64 * @description The sequence of the pin to which the event aggregator should rewind. Either sequence or batch must be specified @@ -27646,7 +27646,7 @@ export interface operations { }; /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; - } | null; + }; /** @description Previously-terminated FireFly smart contracts */ terminated?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ @@ -27665,7 +27665,7 @@ export interface operations { /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; }[]; - } | null; + }; /** @description Whether multi-party mode is enabled for this namespace */ enabled?: boolean; }; @@ -27675,14 +27675,14 @@ export interface operations { * Format: date-time * @description The time the namespace was created */ - created?: string | null; + created?: string; /** @description A description of the namespace */ description?: string; /** @description The local namespace name */ name?: string; /** @description The shared namespace name within the multiparty network */ networkName?: string; - } | null; + }; /** @description Details of the local node */ node?: { /** @@ -27694,7 +27694,7 @@ export interface operations { name?: string; /** @description Whether the node has been successfully registered */ registered?: boolean; - } | null; + }; /** @description Details of the root organization identity registered for this namespace on the local node */ org?: { /** @description The DID of the organization identity, if registered */ @@ -27718,7 +27718,7 @@ export interface operations { /** @description The verifier string, such as an Ethereum address, or Fabric MSP identifier */ value?: string; }[]; - } | null; + }; /** @description Information about plugins configured on this namespace */ plugins?: { /** @description The blockchain plugins on this namespace */ @@ -27837,19 +27837,19 @@ export interface operations { * Format: uuid * @description If a flush is in progress, this is the UUID of the batch being flushed */ - flushing?: string | null; + flushing?: string; /** @description The last error received by this batch processor while flushing */ lastFlushError?: string; /** * Format: date-time * @description The time of the last flush */ - lastFlushErrorTime?: string | null; + lastFlushErrorTime?: string; /** * Format: date-time * @description The last time a flush was performed */ - lastFlushStartTime?: string | null; + lastFlushStartTime?: string; /** * Format: int64 * @description The total count of batches flushed by this processor since it started @@ -27913,7 +27913,7 @@ export interface operations { location?: any; /** @description The status of the contract listener. One of 'syncing', 'synced', or 'unknown' */ status?: string; - } | null; + }; /** @description Previously-terminated FireFly smart contracts */ terminated?: { /** @description A blockchain specific string, such as a block number, to start listening from. The special strings 'oldest' and 'newest' are supported by all blockchain connectors */ @@ -27932,7 +27932,7 @@ export interface operations { /** @description A blockchain specific contract identifier. For example an Ethereum contract address, or a Fabric chaincode name and channel */ location?: any; }[]; - } | null; + }; /** @description Whether multi-party mode is enabled for this namespace */ enabled?: boolean; /** @description Details of the local node */ @@ -27941,7 +27941,7 @@ export interface operations { * Format: uuid * @description The ID of the pending message that broadcast the identity claim to the network */ - pendingRegistrationMessageId?: string | null; + pendingRegistrationMessageId?: string; /** @description The status of the node registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ status?: string; }; @@ -27951,7 +27951,7 @@ export interface operations { * Format: uuid * @description The ID of the pending message that broadcast the identity claim to the network */ - pendingRegistrationMessageId?: string | null; + pendingRegistrationMessageId?: string; /** @description The status of the organization registration, one of 'unregistered', 'registering', 'registered', and 'unknown' */ status?: string; }; @@ -28016,7 +28016,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string | null; + created?: string; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -28067,13 +28067,13 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean | null; + batch?: boolean; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string | null; + batchTimeout?: string; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string | null; + firstEvent?: string; /** @description Webhooks only: Static headers to set on the webhook request */ headers?: any; /** @description Webhooks only: a set of options for HTTP */ @@ -28087,7 +28087,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string | null; + proxyURL?: string; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -28113,7 +28113,7 @@ export interface operations { /** @description Webhooks only: Static query params to set on the webhook request */ query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number | null; + readAhead?: number; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -28136,7 +28136,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean | null; + withData?: boolean; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -28144,7 +28144,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -28300,7 +28300,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string | null; + created?: string; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -28351,13 +28351,13 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean | null; + batch?: boolean; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string | null; + batchTimeout?: string; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string | null; + firstEvent?: string; /** @description Webhooks only: Static headers to set on the webhook request */ headers?: any; /** @description Webhooks only: a set of options for HTTP */ @@ -28371,7 +28371,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string | null; + proxyURL?: string; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -28397,7 +28397,7 @@ export interface operations { /** @description Webhooks only: Static query params to set on the webhook request */ query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number | null; + readAhead?: number; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -28420,7 +28420,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean | null; + withData?: boolean; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -28428,7 +28428,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string | null; + updated?: string; }; }; }; @@ -28584,7 +28584,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string | null; + created?: string; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -28635,13 +28635,13 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean | null; + batch?: boolean; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string | null; + batchTimeout?: string; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string | null; + firstEvent?: string; /** @description Webhooks only: Static headers to set on the webhook request */ headers?: any; /** @description Webhooks only: a set of options for HTTP */ @@ -28655,7 +28655,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string | null; + proxyURL?: string; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -28681,7 +28681,7 @@ export interface operations { /** @description Webhooks only: Static query params to set on the webhook request */ query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number | null; + readAhead?: number; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -28704,7 +28704,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean | null; + withData?: boolean; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -28712,7 +28712,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string | null; + updated?: string; }; }; }; @@ -28753,7 +28753,7 @@ export interface operations { * Format: date-time * @description Creation time of the subscription */ - created?: string | null; + created?: string; /** @description Ephemeral subscriptions only exist as long as the application is connected, and as such will miss events that occur while the application is disconnected, and cannot be created administratively. You can create one over over a connected WebSocket connection */ ephemeral?: boolean; /** @description Server-side filter to apply to events */ @@ -28804,13 +28804,13 @@ export interface operations { /** @description Subscription options */ options?: { /** @description Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. */ - batch?: boolean | null; + batch?: boolean; /** @description When batching is enabled, the optional timeout to send events even when the batch hasn't filled. */ - batchTimeout?: string | null; + batchTimeout?: string; /** @description Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations */ fastack?: boolean; /** @description Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' */ - firstEvent?: string | null; + firstEvent?: string; /** @description Webhooks only: Static headers to set on the webhook request */ headers?: any; /** @description Webhooks only: a set of options for HTTP */ @@ -28824,7 +28824,7 @@ export interface operations { /** @description The max number of idle connections to hold pooled */ maxIdleConns?: number; /** @description HTTP proxy URL to use for outbound requests to the webhook */ - proxyURL?: string | null; + proxyURL?: string; /** @description The max duration to hold a TLS handshake alive */ requestTimeout?: string; /** @description The max duration to hold a TLS handshake alive */ @@ -28850,7 +28850,7 @@ export interface operations { /** @description Webhooks only: Static query params to set on the webhook request */ query?: any; /** @description The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts */ - readAhead?: number | null; + readAhead?: number; /** @description Webhooks only: Whether to automatically send a reply event, using the body returned by the webhook */ reply?: boolean; /** @description Webhooks only: The tag to set on the reply message */ @@ -28873,7 +28873,7 @@ export interface operations { /** @description Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config */ url?: string; /** @description Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. */ - withData?: boolean | null; + withData?: boolean; }; /** @description The transport plugin responsible for event delivery (WebSockets, Webhooks, JMS, NATS etc.) */ transport?: string; @@ -28881,7 +28881,7 @@ export interface operations { * Format: date-time * @description Last time the subscription was updated */ - updated?: string | null; + updated?: string; }; }; }; @@ -28984,12 +28984,12 @@ export interface operations { * Format: uuid * @description For message events, this is the 'header.cid' field from the referenced message. For certain other event types, a secondary object is referenced such as a token pool */ - correlator?: string | null; + correlator?: string; /** * Format: date-time * @description The time the event was emitted. Not guaranteed to be unique, or to increase between events in the same order as the final sequence events are delivered to your application. As such, the 'sequence' field should be used instead of the 'created' field for querying events in the exact order they are delivered to applications */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID assigned to this event by your local FireFly node @@ -29001,7 +29001,7 @@ export interface operations { * Format: uuid * @description The UUID of an resource that is the subject of this event. The event type determines what type of resource is referenced, and whether this field might be unset */ - reference?: string | null; + reference?: string; /** * Format: int64 * @description A sequence indicating the order in which events are delivered to your application. Assure to be unique per event in your local FireFly database (unlike the created timestamp) @@ -29013,7 +29013,7 @@ export interface operations { * Format: uuid * @description The UUID of a transaction that is event is part of. Not all events are part of a transaction */ - tx?: string | null; + tx?: string; /** * @description All interesting activity in FireFly is emitted as a FireFly event, of a given type. The 'type' combined with the 'reference' can be used to determine how to process the event within your application * @enum {string} @@ -29122,7 +29122,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this balance entry applies to */ - pool?: string | null; + pool?: string; }[]; }; }; @@ -29204,14 +29204,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string | null; + created?: string; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ @@ -29220,17 +29220,17 @@ export interface operations { * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -29239,7 +29239,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -29382,14 +29382,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string | null; + created?: string; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ @@ -29398,17 +29398,17 @@ export interface operations { * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -29417,7 +29417,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -29450,14 +29450,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the token approval */ - created?: string | null; + created?: string; /** @description Token connector specific information about the approval operation, such as whether it applied to a limited balance of a fungible token. See your chosen token connector documentation for details */ info?: any; /** @description The blockchain signing key for the approval request. On input defaults to the first signing key of the organization that operates the node */ @@ -29466,17 +29466,17 @@ export interface operations { * Format: uuid * @description The UUID of this token approval, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this approval using the data field of the approval in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the approval, which must match the namespace of the token pool */ namespace?: string; /** @description The blockchain identity that is granted the approval */ @@ -29485,7 +29485,7 @@ export interface operations { * Format: uuid * @description The UUID the token pool this approval applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description A string identifying the parties and entities in the scope of this approval, as provided by the token connector */ @@ -29569,14 +29569,14 @@ export interface operations { * Format: uuid * @description The UUID the token pool this balance entry applies to */ - pool?: string | null; + pool?: string; /** @description The index of the token within the pool that this balance applies to */ tokenIndex?: string; /** * Format: date-time * @description The last time the balance was updated by applying a transfer event */ - updated?: string | null; + updated?: string; /** @description The URI of the token this balance entry applies to */ uri?: string; }[]; @@ -29706,14 +29706,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -29722,24 +29722,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -29779,14 +29779,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -29795,24 +29795,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -29995,14 +29995,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -30011,24 +30011,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -30068,14 +30068,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -30084,24 +30084,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -30210,7 +30210,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30231,7 +30231,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30245,7 +30245,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -30354,7 +30354,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30375,7 +30375,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30389,7 +30389,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -30437,7 +30437,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30458,7 +30458,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30472,7 +30472,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -30543,7 +30543,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30564,7 +30564,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30578,7 +30578,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -30691,7 +30691,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30712,7 +30712,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30726,7 +30726,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -30774,7 +30774,7 @@ export interface operations { * Format: date-time * @description The creation time of the pool */ - created?: string | null; + created?: string; /** @description Number of decimal places that this token has */ decimals?: number; /** @@ -30795,7 +30795,7 @@ export interface operations { name?: string; /** @description The version of the FireFly interface */ version?: string; - } | null; + }; /** * @description The interface encoding format supported by the connector for this token pool * @enum {string} @@ -30809,7 +30809,7 @@ export interface operations { * Format: uuid * @description The UUID of the broadcast message used to inform the network about this pool */ - message?: string | null; + message?: string; /** @description The method definitions resolved by the token connector to be used by each token operation */ methods?: any; /** @description The name of the token pool. Note the name is not validated against the description of the token on the blockchain */ @@ -30924,14 +30924,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -30940,24 +30940,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31110,14 +31110,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -31126,24 +31126,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31183,14 +31183,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -31199,24 +31199,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31279,14 +31279,14 @@ export interface operations { * Format: uuid * @description The UUID of the blockchain event */ - blockchainEvent?: string | null; + blockchainEvent?: string; /** @description The name of the token connector, as specified in the FireFly core configuration file. Required on input when there are more than one token connectors configured */ connector?: string; /** * Format: date-time * @description The creation time of the transfer */ - created?: string | null; + created?: string; /** @description The source account for the transfer. On input defaults to the value of 'key' */ from?: string; /** @description The blockchain signing key for the transfer. On input defaults to the first signing key of the organization that operates the node */ @@ -31295,24 +31295,24 @@ export interface operations { * Format: uuid * @description The UUID of this token transfer, in the local FireFly node */ - localId?: string | null; + localId?: string; /** * Format: uuid * @description The UUID of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - message?: string | null; + message?: string; /** * Format: byte * @description The hash of a message that has been correlated with this transfer using the data field of the transfer in a compatible token connector */ - messageHash?: string | null; + messageHash?: string; /** @description The namespace for the transfer, which must match the namespace of the token pool */ namespace?: string; /** * Format: uuid * @description The UUID the token pool this transfer applies to */ - pool?: string | null; + pool?: string; /** @description An alphanumerically sortable string that represents this event uniquely with respect to the blockchain */ protocolId?: string; /** @description The target account for the transfer. On input defaults to the value of 'key' */ @@ -31395,7 +31395,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -31472,7 +31472,7 @@ export interface operations { * Format: date-time * @description The time the transaction was created on this node. Note the transaction is individually created with the same UUID on each participant in the FireFly transaction */ - created?: string | null; + created?: string; /** * Format: uuid * @description The UUID of the FireFly transaction @@ -31531,7 +31531,7 @@ export interface operations { * Format: uuid * @description The UUID of the listener that detected this event, or nil for built-in events in the system namespace */ - listener?: string | null; + listener?: string; /** @description The name of the event in the blockchain smart contract */ name?: string; /** @description The namespace of the listener that detected this blockchain event */ @@ -31546,7 +31546,7 @@ export interface operations { * Format: date-time * @description The time allocated to this event by the blockchain. This is the block timestamp for most blockchain connectors */ - timestamp?: string | null; + timestamp?: string; /** @description If this blockchain event is coorelated to FireFly transaction such as a FireFly submitted token transfer, this field is set to the UUID of the FireFly transaction */ tx?: { /** @description The blockchain transaction ID, in the format specific to the blockchain involved in the transaction. Not all FireFly transactions include a blockchain */ @@ -31596,7 +31596,7 @@ export interface operations { * Format: date-time * @description The time the operation was created */ - created?: string | null; + created?: string; /** @description Any error reported back from the plugin for this operation */ error?: string; /** @@ -31616,14 +31616,14 @@ export interface operations { * Format: uuid * @description If this operation was initiated as a retry to a previous operation, this field points to the UUID of the operation being retried */ - retry?: string | null; + retry?: string; /** @description The current status of the operation */ status?: string; /** * Format: uuid * @description The UUID of the FireFly transaction the operation is part of */ - tx?: string | null; + tx?: string; /** * @description The type of the operation * @enum {string} @@ -31633,7 +31633,7 @@ export interface operations { * Format: date-time * @description The last update time of the operation */ - updated?: string | null; + updated?: string; }[]; }; }; @@ -31686,7 +31686,7 @@ export interface operations { * Format: date-time * @description The time relevant to when the record was updated, such as the time an event was created, or the last update time of an operation */ - timestamp?: string | null; + timestamp?: string; /** @description The type of the transaction status detail record */ type?: string; }[]; @@ -31749,17 +31749,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string | null; + created?: string; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string | null; + identity?: string; /** @description The namespace of the verifier */ namespace?: string; /** @@ -31806,17 +31806,17 @@ export interface operations { * Format: date-time * @description The time this verifier was created on this node */ - created?: string | null; + created?: string; /** * Format: byte * @description Hash used as a globally consistent identifier for this namespace + type + value combination on every node in the network */ - hash?: string | null; + hash?: string; /** * Format: uuid * @description The UUID of the parent identity that has claimed this verifier */ - identity?: string | null; + identity?: string; /** @description The namespace of the verifier */ namespace?: string; /** @@ -31959,7 +31959,7 @@ export interface operations { * Format: date-time * @description The time the subscription started (reset on dynamic namespace reload) */ - startTime?: string | null; + startTime?: string; }[]; /** @description The user agent of the connected client (if available) */ userAgent?: string; diff --git a/scripts/parseSchema.ts b/scripts/parseSchema.ts index 3289659..e3992e1 100644 --- a/scripts/parseSchema.ts +++ b/scripts/parseSchema.ts @@ -16,17 +16,14 @@ async function run() { return ANY; } - if ( - schemaObject.type === 'string' && - schemaObject.format === 'uuid' && - schemaObject.nullable && - options.path && - options.path.indexOf('/responses/') >= 0 && - options.path.endsWith('/id') - ) { - // For IDs in a response body, override to be non-nullable + if (schemaObject.type === undefined) { + // For objects with undefined type, use "any" instead of "unknown" + return ANY; + } + + if (options.path && options.path.indexOf('/responses/') >= 0 && schemaObject.nullable) { + // Override all response fields to be non-nullable (but allow undefined) schemaObject.nullable = false; - return STRING; } }, }); From 4ce9512b50ab04aa7ffd20ea799f437311182562 Mon Sep 17 00:00:00 2001 From: Andrew Richardson Date: Thu, 1 May 2025 11:55:23 -0400 Subject: [PATCH 7/7] Bump version to 1.3.3 Signed-off-by: Andrew Richardson --- package-lock.json | 4 ++-- package.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 953bf42..f182d2a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@hyperledger/firefly-sdk", - "version": "1.3.1", + "version": "1.3.3", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@hyperledger/firefly-sdk", - "version": "1.3.1", + "version": "1.3.3", "license": "Apache-2.0", "dependencies": { "axios": "^1.6.8", diff --git a/package.json b/package.json index ba12f61..18f1ec9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@hyperledger/firefly-sdk", - "version": "1.3.1", + "version": "1.3.3", "description": "Client SDK for Hyperledger FireFly", "main": "dist/index.js", "types": "dist/index.d.ts", @@ -45,4 +45,4 @@ "form-data": "^4.0.0", "ws": "^8.17.1" } -} \ No newline at end of file +}